Skip to content

This documentation site is deprecated. Please visit our new documentation site at lancedb.com/docs for the latest information.

@lancedb/lancedb β€’ Docs


@lancedb/lancedb / 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

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

Constructors

new StaticHeaderProvider()

new StaticHeaderProvider(headers): StaticHeaderProvider

Initialize with static headers.

Parameters

  • headers: Record<string, string> Headers to return for every request.

Returns

StaticHeaderProvider

Overrides

HeaderProvider.constructor

Methods

getHeaders()

getHeaders(): Record<string, string>

Return the static headers.

Returns

Record<string, string>

Copy of the static headers.

Overrides

HeaderProvider.getHeaders