Function: registerFamilyDefaults()

registerFamilyDefaults(family, defaults): void

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

For family runtimes: install the transport / auth / retry statuses / retry budget / timeout a family needs by default. A user configure entry for the same family (or a retries / timeoutMs the user set) still wins.

Parameters

family

string

Family stem ("nfl_api", "pff_api", "nba_stats", …).

defaults

FamilyDefaults

The FamilyDefaults to install; merged over anything already registered for family, field by field.

Returns

void

Nothing.

Example

import { registerFamilyDefaults, headerAuth, InvalidParameterError } from 'sportsdataverse';

registerFamilyDefaults('my_api', {
  auth: headerAuth({ 'X-Api-Key': process.env.MY_API_KEY }),
  retryStatuses: [408, 429, 500, 502, 503, 504], // auth-gated: a 403 is forbidden, not load
  retries: 4,
  classifyError: (res, url) =>
    res.status === 200 ? new InvalidParameterError(`my_api: empty body`, { url, status: 200 }) : undefined,
});

Remarks

Calls merge: registering { retries: 4 } keeps a previously registered transport. Family runtimes call this at import time; resetConfig does not undo it.