1- # Lattice SDK TypeScript Library
1+ # Anduril TypeScript Library
22
33![ ] ( https://www.anduril.com/lattice-sdk/ )
44
5- The Lattice SDK TypeScript library provides convenient access to the Lattice API from TypeScript.
5+ [ ![ fern shield] ( https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen )] ( https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fanduril%2Flattice-sdk-javascript )
6+ [ ![ npm shield] ( https://img.shields.io/npm/v/@anduril-industries/lattice-sdk )] ( https://www.npmjs.com/package/@anduril-industries/lattice-sdk )
7+
8+ The Anduril TypeScript library provides convenient access to the Anduril API from TypeScript.
69
710## Documentation
811
@@ -534,6 +537,18 @@ while (page.hasNextPage()) {
534537
535538## Advanced
536539
540+ ### Additional Headers
541+
542+ If you would like to send additional headers as part of the request, use the ` headers ` request option.
543+
544+ ``` typescript
545+ const response = await client .entities .longPollEntityEvents (... , {
546+ headers: {
547+ ' X-Custom-Header' : ' custom value'
548+ }
549+ });
550+ ```
551+
537552### Retries
538553
539554The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
@@ -554,6 +569,16 @@ const response = await client.entities.longPollEntityEvents(..., {
554569});
555570```
556571
572+ ### Timeouts
573+
574+ The SDK defaults to a 60 second timeout. Use the ` timeoutInSeconds ` option to configure this behavior.
575+
576+ ``` typescript
577+ const response = await client .entities .longPollEntityEvents (... , {
578+ timeoutInSeconds: 30 // override timeout to 30s
579+ });
580+ ```
581+
557582### Aborting Requests
558583
559584The SDK allows users to abort requests at any point by passing in an abort signal.
@@ -602,3 +627,13 @@ const client = new LatticeClient({
602627 fetcher : // provide your implementation here
603628});
604629```
630+
631+ ## Contributing
632+
633+ While we value open-source contributions to this SDK, this library is generated programmatically.
634+ Additions made directly to this library would have to be moved over to our generation code,
635+ otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
636+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
637+ an issue first to discuss with us!
638+
639+ On the other hand, contributions to the README are always very welcome!
0 commit comments