Skip to main content

Function: resolveFamily()

resolveFamily(family): ResolvedFamilyConfig

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

Resolve one family. Transport precedence: user [family] > registered family default > user "default" > axios — a host-required family transport (e.g. TLS impersonation) is never silently replaced by a generic user default. Auth: user [family] > registered default. Retry statuses: registered default > DEFAULT_RETRY_STATUSES. Retries / timeout: a value the user set via configure > registered default > built-in (3 retries, 30 s).

Parameters​

family​

string

Family stem to resolve; a stem nothing registered gets the user / built-in values.

Returns​

ResolvedFamilyConfig

The merged ResolvedFamilyConfig for that family. userAgent is always the user's (or built-in) value; classifyError is only the family's registered one.

Example​

import { resolveFamily } from './core/config.js'; // not re-exported from the package root

const { transport, retries, timeoutMs } = resolveFamily('nfl_api');

Remarks​

Precedence per field, first match wins:

  • transport: user [family] > registered family default > user "default" > axiosTransport.
  • auth: user [family] > registered default (never a user "default").
  • retries / timeoutMs: user-set via configure > registered default > built-in.
  • retryStatuses: registered default > DEFAULT_RETRY_STATUSES. A family runtime (e.g. nfl_auth.ts) calls this for its own token-mint request so a user transport / timeout applies there too.