Class ApiClient

Constructors

constructor

new ApiClient(clientId: string, link: string, accessToken?: string): ApiClient
Parameters
- clientId: string
- link: string
- OptionalaccessToken: string
Returns ApiClient
- Defined in src/core/ApiClient.ts:49

Methods

getTimeout

getTimeout(): number
Returns number
- Defined in src/core/ApiClient.ts:57

setTimeout

setTimeout(timeout: number): void
Parameters
- timeout: number
Returns void
- Defined in src/core/ApiClient.ts:61

getCache

getCache(): ICache | null
Returns ICache | null
- Defined in src/core/ApiClient.ts:65

setCache

setCache(cache: ICache | null): void
Parameters
- cache: ICache | null
Returns void
- Defined in src/core/ApiClient.ts:69

getRateLimiter

getRateLimiter(): IRateLimiter | null
Returns IRateLimiter | null
- Defined in src/core/ApiClient.ts:73

setRateLimiter

setRateLimiter(limiter: IRateLimiter | null): void
Parameters
- limiter: IRateLimiter | null
Returns void
- Defined in src/core/ApiClient.ts:77

getCircuitBreaker

getCircuitBreaker(): ICircuitBreaker | null
Returns ICircuitBreaker | null
- Defined in src/core/ApiClient.ts:81

setCircuitBreaker

setCircuitBreaker(cb: ICircuitBreaker | null): void
Parameters
- cb: ICircuitBreaker | null
Returns void
- Defined in src/core/ApiClient.ts:85

getDeduplicator

getDeduplicator(): IDeduplicator | null
Returns IDeduplicator | null
- Defined in src/core/ApiClient.ts:89

setDeduplicator

setDeduplicator(dedup: IDeduplicator | null): void
Parameters
- dedup: IDeduplicator | null
Returns void
- Defined in src/core/ApiClient.ts:93

getRetryConfig

getRetryConfig(): RetryConfig | null
Returns RetryConfig | null
- Defined in src/core/ApiClient.ts:97

setRetryConfig

setRetryConfig(config: RetryConfig | null): void
Parameters
- config: RetryConfig | null
Returns void
- Defined in src/core/ApiClient.ts:101

getRetryStrategy

getRetryStrategy(): IRetryStrategy | null
Returns IRetryStrategy | null
- Defined in src/core/ApiClient.ts:105

setRetryStrategy

setRetryStrategy(strategy: IRetryStrategy | null): void
Parameters
- strategy: IRetryStrategy | null
Returns void
- Defined in src/core/ApiClient.ts:109

getValidateResponse

getValidateResponse(): boolean
Returns boolean
- Defined in src/core/ApiClient.ts:113

setValidateResponse

setValidateResponse(validate: boolean): void
Parameters
- validate: boolean
Returns void
- Defined in src/core/ApiClient.ts:117

getValidateRequest

getValidateRequest(): boolean
Returns boolean
- Defined in src/core/ApiClient.ts:121

setValidateRequest

setValidateRequest(validate: boolean): void
Parameters
- validate: boolean
Returns void
- Defined in src/core/ApiClient.ts:125

getIncompletePages

getIncompletePages(): IncompletePagesMode
What a pagination path does with a walk it cannot prove complete.

Returns IncompletePagesMode
- Defined in src/core/ApiClient.ts:130

setIncompletePages

setIncompletePages(mode: IncompletePagesMode): void
Parameters
- mode: IncompletePagesMode
Returns void
- Defined in src/core/ApiClient.ts:134

getFetch

getFetch(): FetchLike
Returns FetchLike
- Defined in src/core/ApiClient.ts:138

setFetch

setFetch(fn: FetchLike): void
Parameters
- fn: FetchLike
Returns void
- Defined in src/core/ApiClient.ts:142

getMiddleware

getMiddleware(): MiddlewareManager
Returns MiddlewareManager
- Defined in src/core/ApiClient.ts:146

addRequestInterceptor

addRequestInterceptor(fn: RequestInterceptor): () => void
Parameters
- fn: RequestInterceptor
Returns () => void
- Defined in src/core/ApiClient.ts:150

addResponseInterceptor

addResponseInterceptor(fn: ResponseInterceptor): () => void
Parameters
- fn: ResponseInterceptor
Returns () => void
- Defined in src/core/ApiClient.ts:154

getAuthorizationHeader

getAuthorizationHeader(): string | undefined
Returns string | undefined
- Defined in src/core/ApiClient.ts:158

getLink

getLink(): string
Returns string
- Defined in src/core/ApiClient.ts:162

getClientId

getClientId(): string
Returns string
- Defined in src/core/ApiClient.ts:166

getDatasource

getDatasource(): EsiDatasource | undefined
Returns EsiDatasource | undefined
- Defined in src/core/ApiClient.ts:170

setDatasource

setDatasource(datasource: EsiDatasource | undefined): void
Parameters
- datasource: EsiDatasource | undefined
Returns void
- Defined in src/core/ApiClient.ts:174

getLanguage

getLanguage(): string | undefined
Returns string | undefined
- Defined in src/core/ApiClient.ts:178

setLanguage

setLanguage(language: string | undefined): void
Parameters
- language: string | undefined
Returns void
- Defined in src/core/ApiClient.ts:182

getTenant

getTenant(): string | undefined
The X-Tenant every request names, or undefined for ESI's default.

Returns string | undefined
- Defined in src/core/ApiClient.ts:187

setTenant

setTenant(tenant: string | undefined): void
Parameters
- tenant: string | undefined
Returns void

Throws
VALIDATION_ERROR when the value is not printable ASCII.
- Defined in src/core/ApiClient.ts:192

getUserAgent

getUserAgent(): string | undefined
The application's own user agent, sent ahead of the library's.

Returns string | undefined
- Defined in src/core/ApiClient.ts:198

setUserAgent

setUserAgent(userAgent: string | undefined): void
Parameters
- userAgent: string | undefined
Returns void

Throws
VALIDATION_ERROR when the value is not printable ASCII.
- Defined in src/core/ApiClient.ts:203

getCompatibilityDate

getCompatibilityDate(): string | undefined
Returns string | undefined
- Defined in src/core/ApiClient.ts:210

setCompatibilityDate

setCompatibilityDate(date: string | undefined): void
Parameters
- date: string | undefined
Returns void
- Defined in src/core/ApiClient.ts:214

setAccessToken

setAccessToken(token: string): void
Parameters
- token: string
Returns void
- Defined in src/core/ApiClient.ts:218

setTokenProvider

setTokenProvider(provider: TokenProvider | undefined): void
Parameters
- provider: TokenProvider | undefined
Returns void
- Defined in src/core/ApiClient.ts:222

getLogger

getLogger(): ILogger | null
Returns ILogger | null
- Defined in src/core/ApiClient.ts:226

setLogger

setLogger(logger: ILogger | null): void
Parameters
- logger: ILogger | null
Returns void
- Defined in src/core/ApiClient.ts:230

getClock

getClock(): Clock | null
The clock the pipeline reads time from and waits on (cache age, retry back-off, response time), or null for the wall clock and real timers.

Returns Clock | null
- Defined in src/core/ApiClient.ts:238

setClock

setClock(clock: Clock | null): void
Parameters
- clock: Clock | null
Returns void
- Defined in src/core/ApiClient.ts:242

hasTokenProvider

hasTokenProvider(): boolean
Returns boolean
- Defined in src/core/ApiClient.ts:246

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/core/ApiClient.ts:250

refreshToken

refreshToken(): Promise<string>
Returns Promise<string>
- Defined in src/core/ApiClient.ts:267