RequestManagerTandem

A request manager that combines a RequestList and a RequestQueue. It first reads requests from the RequestList and then, when needed, transfers them in batches to the RequestQueue.

Implements

• IRequestManager

Index

Constructors

• constructor

Methods

• [asyncIterator]
• addRequest
• addRequestsBatched
• fetchNextRequest
• getPendingCount
• getTotalCount
• handledCount
• isEmpty
• isFinished
• markRequestHandled
• reclaimRequest

Constructors

constructor

• new RequestManagerTandem(requestList, requestQueue): RequestManagerTandem

• Parameters

  • requestList: IRequestList

  • requestQueue: IRequestManager

  Returns RequestManagerTandem

Methods

[asyncIterator]

• [asyncIterator](): AsyncGenerator<Request<Dictionary>, void, unknown>

• Implementation of IRequestManager.[asyncIterator]

  Can be used to iterate over the RequestManager instance in a for await .. of loop. Provides an alternative for the repeated use of fetchNextRequest.

  ---

  Returns AsyncGenerator<Request<Dictionary>, void, unknown>

addRequest

• addRequest(requestLike, options): Promise<RequestQueueOperationInfo>

• Implementation of IRequestManager.addRequest

  @inheritDoc

  ---

  Parameters

  • requestLike: Source

  • optionaloptions: RequestQueueOperationOptions

  Returns Promise<RequestQueueOperationInfo>

addRequestsBatched

• addRequestsBatched(requests, options): Promise<AddRequestsBatchedResult>

• Implementation of IRequestManager.addRequestsBatched

  @inheritDoc

  ---

  Parameters

  • requests: RequestsLike

  • optionaloptions: AddRequestsBatchedOptions

  Returns Promise<AddRequestsBatchedResult>

fetchNextRequest

• fetchNextRequest<T>(): Promise<null | Request<T>>

• Implementation of IRequestManager.fetchNextRequest

  Gets the next Request to process.

  The function's Promise resolves to null if there are no more requests to process.

  ---

  Returns Promise<null | Request<T>>

getPendingCount

• getPendingCount(): number

• Implementation of IRequestManager.getPendingCount

  Get an offline approximation of the number of pending requests.

  ---

  Returns number

getTotalCount

• getTotalCount(): number

• Implementation of IRequestManager.getTotalCount

  Get the total number of requests known to the request manager.

  ---

  Returns number

handledCount

• handledCount(): Promise<number>

• Implementation of IRequestManager.handledCount

  Returns number of handled requests.

  ---

  Returns Promise<number>

isEmpty

• isEmpty(): Promise<boolean>

• Implementation of IRequestManager.isEmpty

  Resolves to true if the next call to IRequestManager.fetchNextRequest function would return null, otherwise it resolves to false. Note that even if the provider is empty, there might be some pending requests currently being processed.

  ---

  Returns Promise<boolean>

isFinished

• isFinished(): Promise<boolean>

• Implementation of IRequestManager.isFinished

  Returns true if all requests were already handled and there are no more left.

  ---

  Returns Promise<boolean>

markRequestHandled

• markRequestHandled(request): Promise<null | void | RequestQueueOperationInfo>

• Implementation of IRequestManager.markRequestHandled

  Marks request as handled after successful processing.

  ---

  Parameters

  • request: Request<Dictionary>

  Returns Promise<null | void | RequestQueueOperationInfo>

reclaimRequest

• reclaimRequest(request, options): Promise<null | RequestQueueOperationInfo>

• Implementation of IRequestManager.reclaimRequest

  Reclaims request to the provider if its processing failed. The request will become available in the next fetchNextRequest().

  ---

  Parameters

  • request: Request<Dictionary>

  • optionaloptions: RequestQueueOperationOptions

  Returns Promise<null | RequestQueueOperationInfo>