Skip to main content

Function: headerAuth()

headerAuth(headers): AuthProvider

Defined in: src/core/auth.ts:169

Static headers (e.g. an API-key header); undefined / empty values are dropped.

Parameters​

headers​

Record<string, string | undefined>

Header map; an undefined / null / "" value (an unset env var) is never sent.

Returns​

AuthProvider

An AuthProvider whose apply merges headers under the request's own (case-insensitively; a header the caller set wins). It has no refresh.

Example​

import { configure, headerAuth } from 'sportsdataverse';

configure({ auth: { odds_api: headerAuth({ 'X-Api-Key': process.env.ODDS_API_KEY }) } });

Remarks​

Unlike bearerAuth it never throws for a missing value: with every value empty it sends the request without credentials. The values are read once, when the provider is built.