File tree Expand file tree Collapse file tree 1 file changed +25
-1
lines changed Expand file tree Collapse file tree 1 file changed +25
-1
lines changed Original file line number Diff line number Diff line change 1
- # Lattice SDK TypeScript Library
1
+ # Anduril TypeScript Library
2
2
3
3
![ ] ( https://www.anduril.com/lattice-sdk/ )
4
4
5
+ [ ![ npm shield] ( https://img.shields.io/npm/v/@anduril-industries/lattice-sdk )] ( https://www.npmjs.com/package/@anduril-industries/lattice-sdk )
6
+
5
7
The Lattice SDK TypeScript library provides convenient access to the Lattice API from TypeScript.
6
8
7
9
## Documentation
@@ -534,6 +536,18 @@ while (page.hasNextPage()) {
534
536
535
537
## Advanced
536
538
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
+
537
551
### Retries
538
552
539
553
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(..., {
554
568
});
555
569
```
556
570
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
+
557
581
### Aborting Requests
558
582
559
583
The SDK allows users to abort requests at any point by passing in an abort signal.
You can’t perform that action at this time.
0 commit comments