Version: Next

RequestQueueClientListAndLockHeadResult

Result of listing and locking requests from the queue head.

The spec describes this and RequestQueueClientListHeadResult as separate schemas that disagree about which fields are required, and the locked variant carries a different element type, so both are derived independently.

Hierarchy

Omit<Schemas[LockedRequestQueueHead], keyof RequestQueueClientListAndLockHeadResultRePointed>
RequestQueueClientListAndLockHeadResultRePointed
- RequestQueueClientListAndLockHeadResult

Added in 2.4.1

Index

Properties

optionalinheritedclientKey

clientKey?: string

client-one

The client key used for locking the requests.

inheritedhadMultipleClients

hadMultipleClients: boolean

inheriteditems

items: RequestQueueClientLockedListItem[]

inheritedlimit

limit: number

inheritedlockSecs

lockSecs: number

The number of seconds the locks will be held.

optionalinheritedqueueHasLockedRequests

queueHasLockedRequests?: boolean

true

Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one).

inheritedqueueModifiedAt

queueModifiedAt: Date