Scoutos TypeScript Library


The Scoutos TypeScript library provides convenient access to the Scoutos APIs from TypeScript.

Table of Contents

- Installation
- Reference
- Usage
- Request and Response Types
- Exception Handling
- Streaming Response
- Advanced
- Additional Headers
- Additional Query String Parameters
- Retries
- Timeouts
- Aborting Requests
- Access Raw Response Data
- Runtime Compatibility
- Contributing

Installation

``sh
npm i -s scoutos
`

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

`typescript
import { ScoutClient } from "scoutos";

const client = new ScoutClient({ apiKey: "YOUR_API_KEY" });
await client.workflows.createRevision({
workflow_id: "workflow_id",
workflow_key: "workflow_key",
body: {}
});
`

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
following namespace:

`typescript
import { Scout } from "scoutos";

const request: Scout.WorkflowsCreateRevisionRequest = {
...
};
`

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
will be thrown.

`typescript
import { ScoutError } from "scoutos";

try {
await client.workflows.createRevision(...);
} catch (err) {
if (err instanceof ScoutError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
console.log(err.rawResponse);
}
}
`

Streaming Response

Some endpoints return streaming responses instead of returning the full response at once.
The SDK uses async iterators, so you can consume the responses using a for await...of loop.

`typescript
import { ScoutClient } from "scoutos";

const client = new ScoutClient({ apiKey: "YOUR_API_KEY" });
const response = await client.workflows.runStream("workflow_id", {
environment: "environment",
revision_id: "revision_id",
session_id: "session_id"
});
for await (const item of response) {
console.log(item);
}
`

Advanced

$3

If you would like to send additional headers as part of the request, use the headers request option.

`typescript
const response = await client.workflows.createRevision(..., {
headers: {
'X-Custom-Header': 'custom value'
}
});
`

$3

If you would like to send additional query string parameters as part of the request, use the queryParams request option.

`typescript
const response = await client.workflows.createRevision(..., {
queryParams: {
'customQueryParamKey': 'custom query param value'
}
});
`

$3

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:

- 408 (Timeout)
- 429 (Too Many Requests)
- 5XX (Internal Server Errors)

Use the maxRetries request option to configure this behavior.

`typescript
const response = await client.workflows.createRevision(..., {
maxRetries: 0 // override maxRetries at the request level
});
`

$3

The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.

`typescript
const response = await client.workflows.createRevision(..., {
timeoutInSeconds: 30 // override timeout to 30s
});
`

$3

The SDK allows users to abort requests at any point by passing in an abort signal.

`typescript
const controller = new AbortController();
const response = await client.workflows.createRevision(..., {
abortSignal: controller.signal
});
controller.abort(); // aborts the request
`

$3

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.

`typescript
const { data, rawResponse } = await client.workflows.createRevision(...).withRawResponse();

console.log(data);
console.log(rawResponse.headers['X-My-Header']);
`

$3


The SDK works in the following runtimes:

- Node.js 18+
- Vercel
- Cloudflare Workers
- Deno v1.25+
- Bun 1.0+
- React Native

$3

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.

`typescript
import { ScoutClient } from "scoutos";

const client = new ScoutClient({
...
fetcher: // provide your implementation here
});
``

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!