RequestQueueClient

Index

Methods

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

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>

deleteRequestLock

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

• Parameters

  • id: string

  • optionaloptions: DeleteRequestLockOptions

  Returns Promise<void>

get

• get(): Promise<undefined | RequestQueueInfo>

• Returns Promise<undefined | RequestQueueInfo>

getRequest

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

• Parameters

  • id: string

  Returns Promise<undefined | RequestOptions>

listAndLockHead

• listAndLockHead(options: ListAndLockOptions): Promise<ListAndLockHeadResult>

• Parameters

  • options: ListAndLockOptions

  Returns Promise<ListAndLockHeadResult>

listHead

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

• Parameters

  • optionaloptions: ListOptions

  Returns Promise<QueueHead>

prolongRequestLock

• prolongRequestLock(id: string, options: ProlongRequestLockOptions): Promise<ProlongRequestLockResult>

• Parameters

  • id: string

  • options: ProlongRequestLockOptions

  Returns Promise<ProlongRequestLockResult>

update

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

• Parameters

  • newFields: { name?: string }

  • optionalname: string

  Returns Promise<undefined | Partial<RequestQueueInfo>>

updateRequest

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

• Parameters

  • request: UpdateRequestSchema

  • optionaloptions: RequestOptions

  Returns Promise<QueueOperationInfo>