Function: configure()

configure(opts): void

Defined in: src/core/config.ts:179

Set the transport, auth, retry budget, timeout or User-Agent. Calls merge: map entries are added / replaced per family, scalars replace. A retries / timeoutMs set here applies to every family, including one that registered its own default.

Parameters

opts

ConfigureOptions

What to set (ConfigureOptions). transport: one function (becomes the "default" entry) or a map keyed by family stem; auth: providers keyed by family stem; retries (default 3), timeoutMs (default 30000), userAgent. An omitted field keeps its current value.

Returns

void

Nothing; the module-level configuration is updated in place.

Example

import { configure, bearerAuth, createImpersonatingTransport } from 'sportsdataverse';

configure({
  transport: { nba_stats: createImpersonatingTransport() },
  auth: { pff_api: bearerAuth(process.env.PFF_API_KEY) },
  retries: 2,
  timeoutMs: 60_000,
});

Remarks

A retries / timeoutMs passed here is remembered as user-set even when it equals the built-in value, and then beats a family's registered default. There is no "default" auth entry on purpose: credentials are only ever sent to the family they belong to. resetConfig drops everything set here.