mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-09 13:22:58 +00:00
8da74dcb37
## Summary This PR introduces a `HeaderProvider` which is called for all remote HTTP calls to get the latest headers to inject. This is useful for features like adding the latest auth tokens where the header provider can auto-refresh tokens internally and each request always set the refreshed token. --------- Co-authored-by: Claude <noreply@anthropic.com>
71 lines
1.4 KiB
Markdown
71 lines
1.4 KiB
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / StaticHeaderProvider
|
|
|
|
# Class: StaticHeaderProvider
|
|
|
|
Example implementation: A simple header provider that returns static headers.
|
|
|
|
This is an example implementation showing how to create a HeaderProvider
|
|
for cases where headers don't change during the session.
|
|
|
|
## Example
|
|
|
|
```typescript
|
|
const provider = new StaticHeaderProvider({
|
|
authorization: "Bearer my-token",
|
|
"X-Custom-Header": "custom-value"
|
|
});
|
|
const headers = provider.getHeaders();
|
|
// Returns: {authorization: 'Bearer my-token', 'X-Custom-Header': 'custom-value'}
|
|
```
|
|
|
|
## Extends
|
|
|
|
- [`HeaderProvider`](HeaderProvider.md)
|
|
|
|
## Constructors
|
|
|
|
### new StaticHeaderProvider()
|
|
|
|
```ts
|
|
new StaticHeaderProvider(headers): StaticHeaderProvider
|
|
```
|
|
|
|
Initialize with static headers.
|
|
|
|
#### Parameters
|
|
|
|
* **headers**: `Record`<`string`, `string`>
|
|
Headers to return for every request.
|
|
|
|
#### Returns
|
|
|
|
[`StaticHeaderProvider`](StaticHeaderProvider.md)
|
|
|
|
#### Overrides
|
|
|
|
[`HeaderProvider`](HeaderProvider.md).[`constructor`](HeaderProvider.md#constructors)
|
|
|
|
## Methods
|
|
|
|
### getHeaders()
|
|
|
|
```ts
|
|
getHeaders(): Record<string, string>
|
|
```
|
|
|
|
Return the static headers.
|
|
|
|
#### Returns
|
|
|
|
`Record`<`string`, `string`>
|
|
|
|
Copy of the static headers.
|
|
|
|
#### Overrides
|
|
|
|
[`HeaderProvider`](HeaderProvider.md).[`getHeaders`](HeaderProvider.md#getheaders)
|