Interface LockManagerWorkerContext

Minimal interface that LockManager needs from Worker. This allows LockManager to access worker methods without inheriting from QueueBase.

interface LockManagerWorkerContext {
    name: string;
    emit(event: string | symbol, ...args: any[]): boolean;
    extendJobLocks(
        jobIds: string[],
        tokens: string[],
        duration: number,
    ): Promise<string[]>;
    trace<T>(
        spanKind: any,
        operation: string,
        destination: string,
        callback: (span?: Span) => T | Promise<T>,
    ): T | Promise<T>;
}

Index

Properties

name

Methods

emit extendJobLocks trace

Properties

name

name: string

Queue name for telemetry.

Methods

emit

emit(event: string | symbol, ...args: any[]): boolean
Emits events to worker listeners.
Parameters
- event: string | symbol
- ...args: any[]
Returns boolean
- Defined in interfaces/lock-manager-worker-context.ts:20

extendJobLocks

extendJobLocks(
    jobIds: string[],
    tokens: string[],
    duration: number,
): Promise<string[]>
Extends locks for multiple jobs.
Parameters
- jobIds: string[]
- tokens: string[]
- duration: number
Returns Promise<string[]>
- Defined in interfaces/lock-manager-worker-context.ts:11

trace

trace<T>(
    spanKind: any,
    operation: string,
    destination: string,
    callback: (span?: Span) => T | Promise<T>,
): T | Promise<T>
Wraps code with telemetry tracing.
Type Parameters
- T
Parameters
- spanKind: any
- operation: string
- destination: string
- callback: (span?: Span) => T | Promise<T>
Returns T | Promise<T>
- Defined in interfaces/lock-manager-worker-context.ts:25

Interface LockManagerWorkerContext

Index

Properties

Methods

Properties

name

Methods

emit

Parameters

Returns boolean

extendJobLocks

Parameters

Returns Promise<string[]>

trace

Type Parameters

Parameters

Returns T | Promise<T>

Settings

On This Page