The Ittybit TypeScript library provides convenient access to the Ittybit API from TypeScript.
Installation
Usage
Instantiate and use the client with the following:
Request And Response Types
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace:
Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
Advanced
Additional Headers
If you would like to send additional headers as part of the request, use the headers
request option.
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
Use the maxRetries
request option to configure this behavior.
Timeouts
The SDK defaults to a 60 second timeout. Use the timeoutInSeconds
option to configure this behavior.
Aborting Requests
The SDK allows users to abort requests at any point by passing in an abort signal.
Access Raw Response Data
The SDK provides access to raw response data, including headers, through the .withRawResponse()
method.
The .withRawResponse()
method returns a promise that results to an object with a data
and a rawResponse
property.
Runtime Compatibility
The SDK defaults to node-fetch
but will use the global fetch client if present. The SDK works in the following
runtimes:
- Node.js 18+
- Vercel
- Cloudflare Workers
- Deno v1.25+
- Bun 1.0+
- React Native
Customizing Fetch Client
The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an unsupported environment, this provides a way for you to break glass and ensure the SDK works.