Interface ApiClient

Hierarchy

ApiClient

Implemented by

HttpApiClient

Index

Methods

batchQuery publish query queryIteratePages queryIterator setAuthenticator subscribe

Methods

batchQuery

batchQuery(queries): Promise<Envelope[][]>
Parameters
- queries: Flatten<QueryParams & Flatten<Omit<QueryAllOptions, "limit"> & {
  pageSize?: number;
  }>>[]
Returns Promise<Envelope[][]>
- Defined in src/ApiClient.ts:144

publish

publish(messages): Promise<PublishResponse>
Parameters
- messages: PublishParams[]
Returns Promise<PublishResponse>
- Defined in src/ApiClient.ts:143

query

query(params, options): Promise<Envelope[]>
Parameters
- params: QueryParams
- options: QueryAllOptions
Returns Promise<Envelope[]>
- Defined in src/ApiClient.ts:126

queryIteratePages

queryIteratePages(params, options): AsyncGenerator<Envelope[], any, unknown>
Parameters
- params: QueryParams
- options: Flatten<Omit<QueryAllOptions, "limit"> & {
  pageSize?: number;
  }>
Returns AsyncGenerator<Envelope[], any, unknown>
- Defined in src/ApiClient.ts:134

queryIterator

queryIterator(params, options): AsyncGenerator<Envelope, any, unknown>
Parameters
- params: QueryParams
- options: Flatten<Omit<QueryAllOptions, "limit"> & {
  pageSize?: number;
  }>
Returns AsyncGenerator<Envelope, any, unknown>
- Defined in src/ApiClient.ts:130

setAuthenticator

setAuthenticator(authenticator, cacheExpirySeconds?): void
Parameters
- authenticator: Authenticator
- Optional cacheExpirySeconds: number
Returns void
- Defined in src/ApiClient.ts:145

subscribe

subscribe(params, callback, onConnectionLost?): SubscriptionManager
Parameters
- params: SubscribeParams
- callback: SubscribeCallback
- Optional onConnectionLost: OnConnectionLostCallback
Returns SubscriptionManager
- Defined in src/ApiClient.ts:138

Generated using TypeDoc