Class ApiSettingsV1

Runtime settings container for v1 API calls.

Hierarchy

BaseSettings
- ApiSettingsV1

Index

Constructors

Properties

apiKey baseHeaders dispatcher hostname timeoutSecs

Methods

apiKeyFromEnv getUserAgent hostnameFromEnv

Constructors

constructor

new ApiSettingsV1(__namedParameters: MindeeApiConstructorProps): ApiSettingsV1
Parameters
- __namedParameters: MindeeApiConstructorProps
Returns ApiSettingsV1
Overrides BaseSettings.constructor
- Defined in src/v1/http/apiSettingsV1.ts:17

Properties

apiKey

apiKey: string

API key used for authenticated requests.

baseHeaders

baseHeaders: Record<string, string>

Default headers sent with each v1 API request.

dispatcher

dispatcher: Dispatcher

HTTP dispatcher used by undici.

hostname

hostname: string

API hostname used for requests.

timeoutSecs

timeoutSecs: number

Request timeout in seconds.

Methods

`Protected`apiKeyFromEnv

apiKeyFromEnv(): string
Resolves the API key from environment variables.

Returns string
Overrides BaseSettings.apiKeyFromEnv
- Defined in src/v1/http/apiSettingsV1.ts:36

`Protected`getUserAgent

getUserAgent(): string
Builds a default user-agent string for outgoing requests.

Returns string
Inherited from BaseSettings.getUserAgent
- Defined in src/http/baseSettings.ts:36

`Protected`hostnameFromEnv

hostnameFromEnv(): string
Resolves the API hostname from environment variables.

Returns string
Overrides BaseSettings.hostnameFromEnv
- Defined in src/v1/http/apiSettingsV1.ts:48