HttpApiClient | @xmtp/xmtp-js

ApiClient provides a wrapper for calling the GRPC Gateway generated code. It adds some helpers for dealing with paginated data and automatically retries idempotent calls

Hierarchy

HttpApiClient

Implements

ApiClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HttpApiClient(pathPrefix: string, opts?: ApiClientOptions): HttpApiClient

- Defined in ApiClient.ts:172
Parameters
- pathPrefix: string
- Optional opts: ApiClientOptions
Returns HttpApiClient

Properties

appVersion

appVersion: undefined | string

maxRetries

maxRetries: number

pathPrefix

pathPrefix: string

version

version: string

Methods

batchQuery

batchQuery(queries: Flatten<QueryParams & Flatten<Omit<QueryAllOptions, "limit"> & { pageSize?: number }>>[]): Promise<Envelope[][]>

Implementation of ApiClient.batchQuery
- Defined in ApiClient.ts:396
Parameters
- queries: Flatten<QueryParams & Flatten<Omit<QueryAllOptions, "limit"> & { pageSize?: number }>>[]
Returns Promise<Envelope[][]>

headers

headers(): Headers

- Defined in ApiClient.ts:512
Returns Headers

publish

publish(messages: PublishParams[]): Promise<PublishResponse>

Implementation of ApiClient.publish
- Defined in ApiClient.ts:455
Parameters
- messages: PublishParams[]
Returns Promise<PublishResponse>

query

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

Implementation of ApiClient.query
- Defined in ApiClient.ts:316
Parameters
- params: QueryParams
- __namedParameters: QueryAllOptions
Returns Promise<Envelope[]>

queryIteratePages

queryIteratePages(__namedParameters: QueryParams, __namedParameters: Flatten<Omit<QueryAllOptions, "limit"> & { pageSize?: number }>): AsyncGenerator<Envelope[], any, unknown>

Implementation of ApiClient.queryIteratePages
- Defined in ApiClient.ts:355
Parameters
- __namedParameters: QueryParams
- __namedParameters: Flatten<Omit<QueryAllOptions, "limit"> & { pageSize?: number }>
Returns AsyncGenerator<Envelope[], any, unknown>

queryIterator

queryIterator(params: QueryParams, options: Flatten<Omit<QueryAllOptions, "limit"> & { pageSize?: number }>): AsyncGenerator<Envelope, any, unknown>

Implementation of ApiClient.queryIterator
- Defined in ApiClient.ts:342
Parameters
- params: QueryParams
- options: Flatten<Omit<QueryAllOptions, "limit"> & { pageSize?: number }>
Returns AsyncGenerator<Envelope, any, unknown>

setAuthenticator

setAuthenticator(authenticator: Authenticator, cacheExpirySeconds?: number): void

Implementation of ApiClient.setAuthenticator
- Defined in ApiClient.ts:505
Parameters
- authenticator: Authenticator
- Optional cacheExpirySeconds: number
Returns void

subscribe(params: SubscribeParams, callback: SubscribeCallback, onConnectionLost?: OnConnectionLostCallback): SubscriptionManager

Implementation of ApiClient.subscribe
- Defined in ApiClient.ts:482
Parameters
- params: SubscribeParams
- callback: SubscribeCallback
- Optional onConnectionLost: OnConnectionLostCallback
Returns SubscriptionManager

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

pathPrefix: string

Optional opts: ApiClientOptions

Returns HttpApiClient

Properties

appVersion

maxRetries

pathPrefix

version

Methods

batchQuery

Parameters

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

Returns Promise<Envelope[][]>

headers

Returns Headers

publish

Parameters

messages: PublishParams[]

Returns Promise<PublishResponse>

query

Parameters

params: QueryParams

__namedParameters: QueryAllOptions

Returns Promise<Envelope[]>

queryIteratePages

Parameters

__namedParameters: QueryParams

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

Returns AsyncGenerator<Envelope[], any, unknown>

queryIterator

Parameters

params: QueryParams

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

Returns AsyncGenerator<Envelope, any, unknown>

setAuthenticator

Parameters

authenticator: Authenticator

Optional cacheExpirySeconds: number

Returns void

subscribe

Parameters

params: SubscribeParams

callback: SubscribeCallback

Optional onConnectionLost: OnConnectionLostCallback

Returns SubscriptionManager