Skip to main content
Version: 3.2

RequestQueueClient

Index

Methods

addRequest

  • addRequest(request: RequestSchema, options?: RequestOptions): Promise<QueueOperationInfo>
  • Parameters

    • request: RequestSchema
    • optionaloptions: RequestOptions

    Returns Promise<QueueOperationInfo>

batchAddRequests

  • batchAddRequests(requests: RequestSchema[], options?: RequestOptions): Promise<BatchAddRequestsResult>
  • Parameters

    • requests: RequestSchema[]
    • optionaloptions: RequestOptions

    Returns Promise<BatchAddRequestsResult>

delete

  • delete(): Promise<void>
  • Returns Promise<void>

deleteRequest

  • deleteRequest(_id: string): Promise<unknown>
  • Parameters

    • _id: string

    Returns Promise<unknown>

get

  • get(): Promise<undefined | RequestQueueInfo>
  • Returns Promise<undefined | RequestQueueInfo>

getRequest

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

    • id: string

    Returns Promise<undefined | RequestOptions>

listHead

  • listHead(options?: ListOptions): Promise<QueueHead>
  • Parameters

    • optionaloptions: ListOptions

    Returns Promise<QueueHead>

update

  • update(newFields: { name?: string }): Promise<undefined | Partial<RequestQueueInfo>>
  • Parameters

    • newFields: { name?: string }

    Returns Promise<undefined | Partial<RequestQueueInfo>>

updateRequest

  • updateRequest(request: UpdateRequestSchema, options?: RequestOptions): Promise<QueueOperationInfo>
  • Parameters

    • request: UpdateRequestSchema
    • optionaloptions: RequestOptions

    Returns Promise<QueueOperationInfo>