RequestQueueClient

@hideconstructor

Hierarchy

• ResourceClient
  • RequestQueueClient

Index

Constructors

• constructor

Properties

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

Methods

• addRequest
• delete
• deleteRequest
• get
• getRequest
• listHead
• update
• updateRequest

Constructors

constructor

• new RequestQueueClient(options: ApiClientSubResourceOptions, userOptions?: RequestQueueUserOptions): RequestQueueClient

• Overrides ResourceClient.constructor

  Parameters

  • options: ApiClientSubResourceOptions

  • userOptions: RequestQueueUserOptions = {}

  Returns RequestQueueClient

Properties

apifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

baseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

httpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalid

id?: string

Inherited from ResourceClient.id

optionalparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

resourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalsafeId

safeId?: string

Inherited from ResourceClient.safeId

url

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>

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>

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>

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>

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>