Skip to content

Commit a690f46

Browse files
🌿 Fern Regeneration -- August 6, 2025 (#71)
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Armin Farshidfard <[email protected]>
1 parent add9abb commit a690f46

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# Lattice SDK TypeScript Library
1+
# Anduril TypeScript Library
22

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

5+
[![npm shield](https://img.shields.io/npm/v/@anduril-industries/lattice-sdk)](https://www.npmjs.com/package/@anduril-industries/lattice-sdk)
6+
57
The Lattice SDK TypeScript library provides convenient access to the Lattice API from TypeScript.
68

79
## Documentation
@@ -534,6 +536,18 @@ while (page.hasNextPage()) {
534536

535537
## Advanced
536538

539+
### Additional Headers
540+
541+
If you would like to send additional headers as part of the request, use the `headers` request option.
542+
543+
```typescript
544+
const response = await client.entities.longPollEntityEvents(..., {
545+
headers: {
546+
'X-Custom-Header': 'custom value'
547+
}
548+
});
549+
```
550+
537551
### Retries
538552

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

571+
### Timeouts
572+
573+
The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
574+
575+
```typescript
576+
const response = await client.entities.longPollEntityEvents(..., {
577+
timeoutInSeconds: 30 // override timeout to 30s
578+
});
579+
```
580+
557581
### Aborting Requests
558582

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

0 commit comments

Comments
 (0)