- Docs
- SDKs
- TypeScript SDK
TypeScript SDK
Install the package @stackly/sdk. It needs Node 20 or newer.
Details
- The SDKs are thin wrappers over the REST API and follow its names closely.
- Each SDK reads the token from the STACKLY_TOKEN environment variable unless you pass one in.
- Pagination helpers return an iterator that follows next_cursor until the list ends.
- Errors are raised as typed exceptions that carry the error code and the request_id.
- The SDKs retry requests that fail with a rate_limited error after the Retry-After delay.
- Releases of the SDKs are listed in the changelog under the API channel.
- Every Stackly plan can use the SDKs, because every plan includes the API.
- Report problems with an SDK to support@stackly.test with the version number.
- The SDKs are thin wrappers over the REST API and follow its names closely. (TypeScript SDK, note 2.)
- Each SDK reads the token from the STACKLY_TOKEN environment variable unless you pass one in. (TypeScript SDK, note 2.)
- Pagination helpers return an iterator that follows next_cursor until the list ends. (TypeScript SDK, note 2.)
- Errors are raised as typed exceptions that carry the error code and the request_id. (TypeScript SDK, note 2.)
- The SDKs retry requests that fail with a rate_limited error after the Retry-After delay. (TypeScript SDK, note 2.)
- Releases of the SDKs are listed in the changelog under the API channel. (TypeScript SDK, note 2.)
- Every Stackly plan can use the SDKs, because every plan includes the API. (TypeScript SDK, note 2.)
Every plan includes the Stackly API, so the steps on this page work on Free, Pro and Business.
See also
Next: Python SDK