RequestQueueClient

Hierarchy

• ResourceClient
  • RequestQueueClient

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• resourcePath
• safeId
• url

Methods

• addRequest
• batchAddRequests
• batchDeleteRequests
• delete
• deleteRequest
• deleteRequestLock
• get
• getRequest
• listAndLockHead
• listHead
• listRequests
• paginateRequests
• prolongRequestLock
• update
• updateRequest

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

inheritedresourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceClient.safeId

inheritedurl

url: string

Inherited from ResourceClient.url

Methods

addRequest

• addRequest(request: Omit<RequestQueueClientRequestSchema, id>, options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientAddRequestResult>

• https://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request

  ---

  Parameters

  • request: Omit<RequestQueueClientRequestSchema, id>

  • options: RequestQueueClientAddRequestOptions = {}

  Returns Promise<RequestQueueClientAddRequestResult>

batchAddRequests

• batchAddRequests(requests: Omit<RequestQueueClientRequestSchema, id>[], options?: RequestQueueClientBatchAddRequestWithRetriesOptions): Promise<RequestQueueClientBatchRequestsOperationResult>

• https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests

  ---

  Parameters

  • requests: Omit<RequestQueueClientRequestSchema, id>[]

  • options: RequestQueueClientBatchAddRequestWithRetriesOptions = {}

  Returns Promise<RequestQueueClientBatchRequestsOperationResult>

batchDeleteRequests

• batchDeleteRequests(requests: RequestQueueClientRequestToDelete[]): Promise<RequestQueueClientBatchRequestsOperationResult>

• https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests

  ---

  Parameters

  • requests: RequestQueueClientRequestToDelete[]

  Returns Promise<RequestQueueClientBatchRequestsOperationResult>

delete

• delete(): Promise<void>

• https://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue

  ---

  Returns Promise<void>

deleteRequest

• deleteRequest(id: string): Promise<void>

• Parameters

  • id: string

  Returns Promise<void>

deleteRequestLock

• deleteRequestLock(id: string, options?: RequestQueueClientDeleteRequestLockOptions): Promise<void>

• https://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock

  ---

  Parameters

  • id: string

  • options: RequestQueueClientDeleteRequestLockOptions = {}

  Returns Promise<void>

get

• get(): Promise<undefined | RequestQueue>

• https://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue

  ---

  Returns Promise<undefined | RequestQueue>

getRequest

• getRequest(id: string): Promise<undefined | RequestQueueClientGetRequestResult>

• https://docs.apify.com/api/v2#/reference/request-queues/request/get-request

  ---

  Parameters

  • id: string

  Returns Promise<undefined | RequestQueueClientGetRequestResult>

listAndLockHead

• listAndLockHead(options: RequestQueueClientListAndLockHeadOptions): Promise<RequestQueueClientListAndLockHeadResult>

• https://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock

  ---

  Parameters

  • options: RequestQueueClientListAndLockHeadOptions

  Returns Promise<RequestQueueClientListAndLockHeadResult>

listHead

• listHead(options?: RequestQueueClientListHeadOptions): Promise<RequestQueueClientListHeadResult>

• https://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head

  ---

  Parameters

  • options: RequestQueueClientListHeadOptions = {}

  Returns Promise<RequestQueueClientListHeadResult>

listRequests

• listRequests(options?: RequestQueueClientListRequestsOptions): Promise<RequestQueueClientListRequestsResult>

• https://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests

  ---

  Parameters

  • options: RequestQueueClientListRequestsOptions = {}

  Returns Promise<RequestQueueClientListRequestsResult>

paginateRequests

• paginateRequests(options?: RequestQueueClientPaginateRequestsOptions): RequestQueueRequestsAsyncIterable<RequestQueueClientListRequestsResult>

• https://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests

  Usage: for await (const { items } of client.paginateRequests({ limit: 10 })) { items.forEach((request) => console.log(request)); }

  ---

  Parameters

  • options: RequestQueueClientPaginateRequestsOptions = {}

  Returns RequestQueueRequestsAsyncIterable<RequestQueueClientListRequestsResult>

prolongRequestLock

• prolongRequestLock(id: string, options: RequestQueueClientProlongRequestLockOptions): Promise<RequestQueueClientProlongRequestLockResult>

• https://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock

  ---

  Parameters

  • id: string

  • options: RequestQueueClientProlongRequestLockOptions

  Returns Promise<RequestQueueClientProlongRequestLockResult>

update

• update(newFields: RequestQueueClientUpdateOptions): Promise<RequestQueue>

• https://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue

  ---

  Parameters

  • newFields: RequestQueueClientUpdateOptions

  Returns Promise<RequestQueue>

updateRequest

• updateRequest(request: RequestQueueClientRequestSchema, options?: RequestQueueClientAddRequestOptions): Promise<RequestQueueClientAddRequestResult>

• https://docs.apify.com/api/v2#/reference/request-queues/request/update-request

  ---

  Parameters

  • request: RequestQueueClientRequestSchema

  • options: RequestQueueClientAddRequestOptions = {}

  Returns Promise<RequestQueueClientAddRequestResult>