Class HttpApiClient

constructor

• new HttpApiClient(pathPrefix, opts?): HttpApiClient

• Parameters

  • pathPrefix: string
  • Optional opts: ApiClientOptions

  Returns HttpApiClient

appVersion

maxRetries

pathPrefix

version

batchQuery

• batchQuery(queries): Promise<Envelope[][]>

• Parameters

  • queries: Flatten<QueryParams & Flatten<Omit<QueryAllOptions, "limit"> & {
        pageSize?: number;
    }>>[]

  Returns Promise<Envelope[][]>

headers

• headers(): Headers

• Returns Headers

publish

• publish(messages): Promise<PublishResponse>

• Parameters

  • messages: PublishParams[]

  Returns Promise<PublishResponse>

query

• query(params, __namedParameters): Promise<Envelope[]>

• Parameters

  • params: QueryParams
  • __namedParameters: QueryAllOptions

  Returns Promise<Envelope[]>

queryIteratePages

• queryIteratePages(__namedParameters, __namedParameters): AsyncGenerator<Envelope[], any, unknown>

• Parameters

  • __namedParameters: QueryParams
  • __namedParameters: Flatten<Omit<QueryAllOptions, "limit"> & {
        pageSize?: number;
    }>

  Returns AsyncGenerator<Envelope[], any, unknown>

queryIterator

• queryIterator(params, options): AsyncGenerator<Envelope, any, unknown>

• Parameters

  • params: QueryParams
  • options: Flatten<Omit<QueryAllOptions, "limit"> & {
        pageSize?: number;
    }>

  Returns AsyncGenerator<Envelope, any, unknown>

setAuthenticator

• setAuthenticator(authenticator, cacheExpirySeconds?): void

• Parameters

  • authenticator: Authenticator
  • Optional cacheExpirySeconds: number

  Returns void

subscribe

• subscribe(params, callback, onConnectionLost?): SubscriptionManager

• Parameters

  • params: SubscribeParams
  • callback: SubscribeCallback
  • Optional onConnectionLost: OnConnectionLostCallback

  Returns SubscriptionManager