Class BaseEsiClient<T>`Abstract`

The base of the custom domain clients: an endpoint map turned into methods, plus the stream*/fetchAll* page helpers and withMetadata/withSafeMode. Extend it for a custom domain client of your own.

Type Parameters

T extends EndpointMap

Index

Constructors

Properties

api _client _endpoints

Methods

streamEndpoint fetchAllEndpoint withMetadata withSafeMode

Constructors

constructor

new BaseEsiClient<T extends EndpointMap>(
client: ApiClient,
endpoints: T,
): BaseEsiClient<T>
Type Parameters
- T extends EndpointMap
Parameters
- client: ApiClient
- endpoints: T
Returns BaseEsiClient<T>
- Defined in src/clients/BaseEsiClient.ts:39

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: T

Methods

streamEndpoint

streamEndpoint<R>(
endpointName: string & keyof T,
...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName: string & keyof T
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName: string & keyof T,
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName: string & keyof T
- args: unknown[]
- Optionalconcurrency: number
Returns Promise<R[]>
- Defined in src/clients/BaseEsiClient.ts:71

withMetadata

withMetadata(): WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
- Defined in src/clients/BaseEsiClient.ts:99

withSafeMode

withSafeMode(): WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
- Defined in src/clients/BaseEsiClient.ts:110