Skip to main content

Function: queryAuth()

queryAuth(params): AuthProvider

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

Static query params (e.g. { apiKey: "…" }); undefined / empty values are dropped.

Parameters​

params​

Record<string, unknown>

Query map; an undefined / null / "" value is never sent.

Returns​

AuthProvider

An AuthProvider whose apply adds params under the request's own query (a key the caller set wins). It has no refresh.

Example​

import { configure, queryAuth } from 'sportsdataverse';

configure({ auth: { odds_api: queryAuth({ apiKey: process.env.ODDS_API_KEY }) } });

Remarks​

A key sent this way rides in the query string, which request() keeps out of every error message (url is query-free) and redactSecrets strips from any text.