griddy-sdk / SDKConfiguration

Class: SDKConfiguration¶

Defined in: src/griddy/nfl/sdkConfiguration.ts:148

SDK Configuration.

Constructors¶

Constructor¶

new SDKConfiguration(options): SDKConfiguration

Defined in: src/griddy/nfl/sdkConfiguration.ts:186

Parameters¶

options¶

SDKConfigurationOptions = {}

Returns¶

SDKConfiguration

Properties¶

asyncClient¶

asyncClient: AsyncHttpClient

Defined in: src/griddy/nfl/sdkConfiguration.ts:154

Asynchronous HTTP client

asyncClientSupplied¶

asyncClientSupplied: boolean

Defined in: src/griddy/nfl/sdkConfiguration.ts:156

Whether the async client was supplied by the user

client¶

client: HttpClient

Defined in: src/griddy/nfl/sdkConfiguration.ts:150

Synchronous HTTP client

clientSupplied¶

clientSupplied: boolean

Defined in: src/griddy/nfl/sdkConfiguration.ts:152

Whether the client was supplied by the user

customAuthInfo¶

customAuthInfo: Record\<string, unknown>

Defined in: src/griddy/nfl/sdkConfiguration.ts:180

Custom auth info

debugLogger¶

debugLogger: Logger

Defined in: src/griddy/nfl/sdkConfiguration.ts:182

Debug logger

genVersion¶

genVersion: string = GEN_VERSION

Defined in: src/griddy/nfl/sdkConfiguration.ts:170

Generator version

language¶

language: string = "typescript"

Defined in: src/griddy/nfl/sdkConfiguration.ts:164

SDK language

openapiDocVersion¶

openapiDocVersion: string = OPENAPI_DOC_VERSION

Defined in: src/griddy/nfl/sdkConfiguration.ts:166

OpenAPI doc version

retryConfig¶

retryConfig: typeof UNSET | RetryConfig

Defined in: src/griddy/nfl/sdkConfiguration.ts:174

Retry configuration

sdkVersion¶

sdkVersion: string = VERSION

Defined in: src/griddy/nfl/sdkConfiguration.ts:168

SDK version

security¶

security: Security | () => Security

Defined in: src/griddy/nfl/sdkConfiguration.ts:158

Security configuration

serverIdx¶

serverIdx: number

Defined in: src/griddy/nfl/sdkConfiguration.ts:162

Server index

serverType¶

serverType: "regular" | "pro" | "ngs"

Defined in: src/griddy/nfl/sdkConfiguration.ts:178

Server type

serverUrl¶

serverUrl: string

Defined in: src/griddy/nfl/sdkConfiguration.ts:160

Server URL override

timeoutMs¶

timeoutMs: number

Defined in: src/griddy/nfl/sdkConfiguration.ts:176

Request timeout in milliseconds

userAgent¶

userAgent: string = USER_AGENT

Defined in: src/griddy/nfl/sdkConfiguration.ts:172

User agent string

Accessors¶

hooks¶

Get Signature¶

get hooks(): SDKHooks

Defined in: src/griddy/nfl/sdkConfiguration.ts:204

Get the hooks instance.

Returns¶

SDKHooks

Set Signature¶

set hooks(hooks): void

Defined in: src/griddy/nfl/sdkConfiguration.ts:211

Set the hooks instance.

Parameters¶

hooks¶

SDKHooks

Returns¶

void

Methods¶

getServerDetails()¶

getServerDetails(): [string, Record\<string, string>]

Defined in: src/griddy/nfl/sdkConfiguration.ts:218

Get server details (URL and variables).

Returns¶

[string, Record\<string, string>]