Queue client signatures

reservedSettingPrefixes(): Array<string>

queue.ackMessage(
    topic: string,
    subscriptionName: string,
    messageId: string
): Promise<boolean>

queue.ackTopicCursor(
    topic: string,
    subscriptionName: string,
    cursor: string
): Promise<boolean>

queue.acquireLock(name: string, ownerId: string, ttlMs: number): boolean

queue.cancelJob(id: string): boolean

queue.cascadeSkipPending(runId: string): void

queue.checkFanOutCompletion(
    runId: string,
    parentNodeName: string
): JsFanOutCompletion | null

queue.closeDashboardAudit(): Promise<void>

queue.compensationNodeForJob(jobId: string): JsWorkflowNodeRef | null

queue.countPendingByQueue(queue: string): number

queue.createDeferredJob(
    runId: string,
    nodeName: string,
    payload: Buffer,
    taskName: string,
    queue: string,
    maxRetries: number,
    timeoutMs: number,
    priority: number
): string

queue.deadLetters(
    limit?: number | undefined | null,
    offset?: number | undefined | null
): Promise<Array<JsDeadJob>>

queue.deadLettersAfter(
    limit?: number | undefined | null,
    after?: string | undefined | null
): Promise<JsDeadJobPage>

queue.deadLettersByTask(
    taskName: string,
    limit?: number | undefined | null,
    offset?: number | undefined | null
): Promise<Array<JsDeadJob>>

queue.declareTopic(
    name: string,
    mode: string,
    retentionMs?: number | undefined | null
): Promise<void>

queue.deleteDead(deadId: string): boolean

queue.deletePeriodic(name: string): boolean

queue.deleteSetting(key: string): boolean

queue.dryRunRetention(
    retention?: RetentionInput | undefined | null
): Promise<string>

queue.effectiveRetention(): string | null

queue.enqueue(
    taskName: string,
    payload: Buffer,
    options?: EnqueueOptions | undefined | null
): string

queue.enqueueCompensation(
    runId: string,
    nodeName: string,
    payload: Buffer,
    taskName: string,
    queue: string,
    maxRetries: number,
    timeoutMs: number,
    priority: number
): string

queue.enqueueMany(
    taskName: string,
    jobs: Array<EnqueueJob>
): Array<string>

queue.expandFanOut(
    runId: string,
    parentNodeName: string,
    childNames: Array<string>,
    childPayloads: Array<Buffer>,
    taskName: string,
    queue: string,
    maxRetries: number,
    timeoutMs: number,
    priority: number
): Array<string>

queue.extendLock(name: string, ownerId: string, ttlMs: number): boolean

queue.finalizeRunIfTerminal(runId: string): string | null

queue.getJob(id: string): JsJob | null

queue.getJobErrors(jobId: string): Promise<Array<JsJobError>>

queue.getLockInfo(name: string): JsLockInfo | null

queue.getMetrics(
    task: string | undefined | null,
    sinceMs: number
): Promise<Array<JsMetric>>

queue.getReplayHistory(jobId: string): Promise<Array<JsReplayEntry>>

queue.getSetting(key: string): string | null

queue.getTaskLogs(jobId: string): Array<JsTaskLog>

queue.getTaskLogsAfter(
    jobId: string,
    afterId?: string | undefined | null
): Array<JsTaskLog>

queue.getWorkflowChildren(runId: string): Array<JsWorkflowRun>

queue.getWorkflowDag(runId: string): string | null

queue.getWorkflowNodes(runId: string): Array<JsWorkflowNode>

queue.getWorkflowRun(runId: string): JsWorkflowRun | null

queue.getWorkflowRunPlan(runId: string): JsWorkflowRunPlan | null

queue.isCancelRequested(id: string): boolean

queue.jobDag(jobId: string): Promise<JsJobDag>

queue.leaseTopicMessages(
    topic: string,
    subscriptionName: string,
    limit: number,
    visibilityMs: number
): Promise<Array<JsTopicMessage>>

queue.listArchived(
    limit?: number | undefined | null,
    offset?: number | undefined | null
): Promise<Array<JsJob>>

queue.listArchivedAfter(
    limit?: number | undefined | null,
    after?: string | undefined | null
): Promise<JsJobPage>

queue.listCircuitBreakers(): Promise<Array<JsCircuitBreaker>>

queue.listDeclaredTopics(): Promise<Array<JsTopic>>

queue.listJobs(
    filter?: JobFilter | undefined | null
): Promise<Array<JsJob>>

queue.listJobsAfter(
    filter?: JobFilter | undefined | null,
    after?: string | undefined | null
): Promise<JsJobPage>

queue.listJobsFiltered(
    filter?: DetailedJobFilter | undefined | null
): Promise<Array<JsJob>>

queue.listJobsFilteredAfter(
    filter?: DetailedJobFilter | undefined | null,
    after?: string | undefined | null
): Promise<JsJobPage>

queue.listPausedQueues(): Array<string>

queue.listPeriodic(): Array<JsPeriodicTask>

queue.listSettings(): Record<string, string>

queue.listSubscriptions(
    topic?: string | undefined | null
): Promise<Array<JsSubscription>>

queue.listWorkers(): Promise<Array<JsWorkerRow>>

queue.listWorkflowRuns(
    definitionName?: string | undefined | null,
    state?: string | undefined | null,
    limit?: number | undefined | null,
    offset?: number | undefined | null
): Array<JsWorkflowRun>

queue.markWorkflowNodeResult(
    jobId: string,
    succeeded: boolean,
    error?: string | undefined | null,
    skipCascade?: boolean | undefined | null
): JsWorkflowAdvance | null

queue.migrate(): Promise<MigrationSummary>

queue.minContract(): number

queue.nackMessage(
    topic: string,
    subscriptionName: string,
    messageId: string
): Promise<boolean>

JsQueue.open(options: OpenOptions): JsQueue

queue.pauseQueue(queue: string): void

queue.publish(
    topic: string,
    payload: Buffer,
    options?: PublishOptions | undefined | null
): Promise<Array<JsJob>>

queue.purgeCompleted(olderThanMs: number): Promise<number>

queue.purgeDead(olderThanMs: number): Promise<number>

queue.purgeDeadByTask(taskName: string): Promise<number>

queue.queryTaskLogs(
    taskName: string | undefined | null,
    level: string | undefined | null,
    sinceMs: number,
    limit: number
): Promise<Array<JsTaskLog>>

queue.readTopicMessages(
    topic: string,
    subscriptionName: string,
    limit: number
): Promise<Array<JsTopicMessage>>

queue.reapEphemeralSubscriptions(
    workerId?: string | undefined | null
): Promise<number>

queue.recordDashboardAction(
    method: string,
    path: string,
    status: number,
    username?: string | undefined | null
): void

queue.registerPeriodic(
    name: string,
    taskName: string,
    cronExpr: string,
    args?: Buffer | undefined | null,
    queue?: string | undefined | null,
    timezone?: string | undefined | null,
    enabled?: boolean | undefined | null
): number

queue.registerSubscription(
    topic: string,
    subscriptionName: string,
    taskName: string,
    queue: string,
    durable: boolean,
    ownerWorkerId?: string | undefined | null,
    priority?: number | undefined | null,
    maxRetries?: number | undefined | null,
    timeoutMs?: number | undefined | null,
    mode?: string | undefined | null
): Promise<void>

queue.releaseLock(name: string, ownerId: string): boolean

queue.replayJob(jobId: string): Promise<string>

queue.requestCancel(id: string): boolean

queue.requestWorkerDrain(workerId: string): boolean

queue.requeueJob(jobId: string): boolean

queue.resolveWorkflowGate(
    runId: string,
    nodeName: string,
    approved: boolean,
    error?: string | undefined | null
): void

queue.resumeQueue(queue: string): void

queue.retryDead(deadId: string): string

queue.runWorker(
    callback: ((arg: JsTaskInvocation) => Promise<JsTaskOutcome>),
    outcomeCallback: ((arg: JsOutcome) => unknown),
    options?: WorkerOptions | undefined | null
): JsWorker

queue.setMinContract(level: number): void

queue.setPeriodicEnabled(name: string, enabled: boolean): boolean

queue.setSetting(key: string, value: string): void

queue.setSettingIf(
    key: string,
    expected: string | undefined | null,
    value: string
): boolean

queue.setSubscriptionActive(
    topic: string,
    subscriptionName: string,
    active: boolean
): Promise<boolean>

queue.setWorkflowNodeCompensated(
    runId: string,
    nodeName: string,
    completedAt: number
): void

queue.setWorkflowNodeCompensationFailed(
    runId: string,
    nodeName: string,
    error: string,
    completedAt: number
): void

queue.setWorkflowNodeRunning(runId: string, nodeName: string): void

queue.setWorkflowNodeWaitingApproval(
    runId: string,
    nodeName: string
): void

queue.setWorkflowRunState(
    runId: string,
    state: string,
    error?: string | undefined | null,
    completedAt?: number | undefined | null
): void

queue.skipWorkflowNode(runId: string, nodeName: string): void

queue.startDashboardAudit(retentionDays: number): void

queue.stats(): Promise<JsStats>

queue.statsAllQueues(): Promise<Record<string, JsStats>>

queue.statsByQueue(queue: string): Promise<JsStats>

queue.submitWorkflow(
    name: string,
    version: number,
    dagBytes: Buffer,
    stepMetadataJson: string,
    nodePayloads: Record<string, Buffer>,
    queueDefault?: string | undefined | null,
    paramsJson?: string | undefined | null,
    deferredNodeNames?: Array<string> | undefined | null,
    parentRunId?: string | undefined | null,
    parentNodeName?: string | undefined | null,
    traceparent?: string | undefined | null,
    tracestate?: string | undefined | null
): string

queue.supportsSteps(): boolean

queue.topicBacklogStats(): Promise<Array<JsTopicStat>>

queue.topicLogStats(): Promise<Array<JsTopicLogStat>>

queue.unsubscribe(
    topic: string,
    subscriptionName: string
): Promise<boolean>

queue.updateProgress(id: string, progress: number): void

queue.workerHeartbeat(
    workerId: string,
    resourceHealth?: string | undefined | null
): Promise<JsHeartbeat>

queue.workflowNodeForJob(jobId: string): JsWorkflowNodeRef | null

queue.writeTaskLog(
    jobId: string,
    taskName: string,
    level: string,
    message: string,
    extra?: string | undefined | null
): void