Skip to content

SDK documentation#

Generated SDKs are largely self-documenting. They include complete instructions for installing via the relevant package manager, or downloading an archive if that's not available. Some SDKs also provide a generated API reference.

API reference#

Most Go and JavaScript/Typescript SDKs have an easily accessible API reference on the SDK page. It's always in sync with the plugin version and module commit specified by the SDK, and is presented in the way that's standard for each language. Click the API reference button at the top right of the SDK to view it.

Screenshot of the API reference button

If the API reference for the SDK hasn't been generated before, the BSR displays a "Docs Generating" banner—otherwise, it displays a link to the reference's root directory. Click through to a package and it shows its import statement and links to each of the package's descendants—you can navigate around the documentation from there.