Class AbstractApiClient`Abstract`

A class representing some kind of client retrieving resources over the internet, like an API or SQL server.

Remarks

In order to use this class, it must be extended first and then use the sendRequest method.

Hierarchy

AbstractApiClient
- OpenaiApiClient

Index

Constructors

constructor

new AbstractApiClient(options?): AbstractApiClient
Create a new OpenaiApiClient instance.
Parameters
- options: IAbstractApiClientOptions = {}
  
  The constructor options to use.
Returns AbstractApiClient
- Defined in packages/api-util/src/lib/AbstractApiClient.ts:99

Properties

`Optional` `Readonly` cache

cache?: ApiReponseCache<any>

API response cache

`Readonly` cacheDefaults

cacheDefaults: IResponseCacheOptions = ...

Default options for caching for api requests. Can be overriden in individual method calls.

`Readonly` events

events: EventEmitter = ...

Event emitter for cache events

`Readonly` queue

queue: PromiseQueue<IQueue<(() => Promise<unknown>), IQueueAddOptions>, IQueueAddOptions>

Global queue for sending requests to the openai api.

`Readonly` retryDefaults

retryDefaults: IAsyncRetryOptions = ...

Default options for async retry for api requests. Can be overriden in individual method calls.

`Protected` `Readonly` sendRequest

sendRequest: (<T>(options) => Promise<T>)

Type declaration

- <T>(options): Promise<T>
- Generic function for sending requests to the openai api. This is used for all the API endpoints. It handles retrying, cache, hashing, and emitting events. This method is bound to the instance on initialization because it gets wrapped with a concurrency controller in the constructor.
  Type Parameters
  - T
  Parameters
  - options: {
        apiRequest: (() => Promise<T>);
        args: any[];
        cache?: IResponseCacheOptions;
        retry?: IAsyncRetryOptions;
    }
    - apiRequest: (() => Promise<T>)
      
      (): Promise<T>
      
      Returns Promise<T>
    - args: any[]
    - Optional cache?: IResponseCacheOptions
    - Optional retry?: IAsyncRetryOptions
  Returns Promise<T>

`Static` `Readonly` concurrencyDefaults

concurrencyDefaults: IPromiseQueueOptions<IQueue<(() => Promise<unknown>), IQueueAddOptions>, IQueueAddOptions> = ...

Options for concurrency control. These affect all API requests.

Accessors

eventNames

get eventNames(): string[]
All emitted event names. Please note that the cache also emits events.

Returns string[]
- Defined in packages/api-util/src/lib/AbstractApiClient.ts:26

Methods

`Protected` emit

emit<T>(event, arg): T
Emit an event but adds 'this' as an extra trailing argument.
Type Parameters
- T
Parameters
- event: string
  
  The event name.
- arg: T
  
  The argument to emit.
Returns T
- Defined in packages/api-util/src/lib/AbstractApiClient.ts:182

`Protected` handleCacheOptions

handleCacheOptions(cacheOptions?): IResponseCacheOptions
Handle cache options.
Parameters
- Optional cacheOptions: IResponseCacheOptions
  
  The cache options to handle.
Returns IResponseCacheOptions
- Defined in packages/api-util/src/lib/AbstractApiClient.ts:173

`Protected` handleOptions

handleOptions(options): IAbstractApiClientOptions
Handle the options passed to the constructor.
Parameters
- options: IAbstractApiClientOptions
  
  The options to handle.
Returns IAbstractApiClientOptions
- Defined in packages/api-util/src/lib/AbstractApiClient.ts:149

`Protected` handleRetryOptions

handleRetryOptions(retryOptions?): IAsyncRetryOptions
Handle retry options.
Parameters
- Optional retryOptions: IAsyncRetryOptions
  
  The retry options to handle.
Returns IAsyncRetryOptions
- Defined in packages/api-util/src/lib/AbstractApiClient.ts:165

Class AbstractApiClientAbstract

Remarks

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: IAbstractApiClientOptions = {}

Returns AbstractApiClient

Properties

Optional Readonly cache

Readonly cacheDefaults

Readonly events

Readonly queue

Readonly retryDefaults

Protected Readonly sendRequest

Type declaration

Type Parameters

T

Parameters

options: { apiRequest: (() => Promise<T>); args: any[]; cache?: IResponseCacheOptions; retry?: IAsyncRetryOptions; }

apiRequest: (() => Promise<T>)

Returns Promise<T>

args: any[]

Optional cache?: IResponseCacheOptions

Optional retry?: IAsyncRetryOptions

Returns Promise<T>

Static Readonly concurrencyDefaults

Accessors

eventNames

Returns string[]

Methods

Protected emit

Type Parameters

T

Parameters

event: string

arg: T

Returns T

Protected handleCacheOptions

Parameters

Optional cacheOptions: IResponseCacheOptions

Returns IResponseCacheOptions

Protected handleOptions

Parameters

options: IAbstractApiClientOptions

Returns IAbstractApiClientOptions

Protected handleRetryOptions

Parameters

Optional retryOptions: IAsyncRetryOptions

Returns IAsyncRetryOptions

Settings

Member Visibility

Theme

On This Page

Class AbstractApiClient`Abstract`

`Optional` `Readonly` cache

`Readonly` cacheDefaults

`Readonly` events

`Readonly` queue

`Readonly` retryDefaults

`Protected` `Readonly` sendRequest

options: {
apiRequest: (() => Promise<T>);
args: any[];
cache?: IResponseCacheOptions;
retry?: IAsyncRetryOptions;
}

`Optional` cache?: IResponseCacheOptions

`Optional` retry?: IAsyncRetryOptions

`Static` `Readonly` concurrencyDefaults

`Protected` emit

`Protected` handleCacheOptions

`Optional` cacheOptions: IResponseCacheOptions

`Protected` handleOptions

`Protected` handleRetryOptions

`Optional` retryOptions: IAsyncRetryOptions