function createApiKeyAuthInterceptor
Since 0.1.0
createApiKeyAuthInterceptor(
key: string | (() => Promise<string>),
headerName?: string
): ClientRequestInterceptor

Create a request interceptor that sets an API-key header.

The default header name is X-API-Key. The header is only set when the request does not already carry that header.

Parameters

key: string | (() => Promise<string>)

Static API key or async provider returning one.

optional
headerName: string = X-API-Key

Header name (default X-API-Key).

Return Type

A request interceptor.

Usage

import { createApiKeyAuthInterceptor } from "sdk/src/index.ts";