Interface UniqueJobDispatcherOptions

Options for createUniqueJobDispatcher(...).

interface UniqueJobDispatcherOptions {
    jobs: JobDispatcher;
    keyPrefix?: string;
    locks: LocksPort;
    onDuplicate?: (args: UniqueJobDuplicateArgs) => MaybePromise<void>;
}

Index

Properties

jobs keyPrefix? locks onDuplicate?

Properties

jobs

jobs: JobDispatcher

Dispatcher to call when a job is not unique or the unique lease is acquired.

`Optional`keyPrefix

keyPrefix?: string

Prefix for concrete lock keys.

Defaults to "jobs:unique".

locks

locks: LocksPort

Lease-backed lock port used as the uniqueness guard.

`Optional`onDuplicate

onDuplicate?: (args: UniqueJobDuplicateArgs) => MaybePromise<void>

Called when a duplicate dispatch is suppressed.