Class MetadataTransport

Resolves each request with the body and the metadata of its response.

Implements

OperationTransport

Index

Constructors

Methods

request paginate

Constructors

constructor

new MetadataTransport(
client: ApiClient,
options?: PipelineTransportOptions,
): MetadataTransport
Parameters
- client: ApiClient
- options: PipelineTransportOptions = {}
Returns MetadataTransport
- Defined in src/client/modes.ts:91

Methods

request

request<T>(meta: OperationMeta, req: OperationRequest): Promise<T>
Type Parameters
- T
Parameters
- meta: OperationMeta
- req: OperationRequest
Returns Promise<T>
Implementation of OperationTransport.request
- Defined in src/client/modes.ts:96

paginate

paginate<T>(meta: OperationMeta, req: OperationRequest): AsyncIterable<T>
Follows X-Pages; yields one item at a time across every page.
Type Parameters
- T
Parameters
- meta: OperationMeta
- req: OperationRequest
Returns AsyncIterable<T>
Implementation of OperationTransport.paginate
- Defined in src/client/modes.ts:111