Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Lattice SDK TypeScript Library
# Anduril TypeScript Library

![](https://www.anduril.com/lattice-sdk/)

[![npm shield](https://img.shields.io/npm/v/@anduril-industries/lattice-sdk)](https://www.npmjs.com/package/@anduril-industries/lattice-sdk)

The Lattice SDK TypeScript library provides convenient access to the Lattice API from TypeScript.

## Documentation
Expand Down Expand Up @@ -534,6 +536,18 @@ while (page.hasNextPage()) {

## Advanced

### Additional Headers

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

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

### Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
Expand All @@ -554,6 +568,16 @@ const response = await client.entities.longPollEntityEvents(..., {
});
```

### Timeouts

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

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

### Aborting Requests

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