Interface OpviousClientOptions

Hierarchy

  • OpviousClientOptions

Properties

endpoint? maxRetryDelayMillis? telemetry? token?

Properties

Optional Readonly endpoint

endpoint?: string | false | URL

Base API endpoint URL. If undefined, uses process.env.OPVIOUS_ENDPOINT if set, and falls back to the default endpoint otherwise. Setting this to false will always use the default endpoint.

Optional Readonly maxRetryDelayMillis

maxRetryDelayMillis?: number

Maximum number of milliseconds to wait for when retrying rate-limited requests. Defaults to 2_500.

Optional Readonly telemetry

telemetry?: Telemetry

Telemetry instance used for logging, etc.

Optional Readonly token

token?: string

API authorization header or access token, defaulting to process.env.OPVIOUS_TOKEN.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc