bunqueue v2.8 API referenceall versions · guide
bunqueue
    Preparing search index...

    Interface ToPublicJobOptions

    Options for creating a simple public job

    interface ToPublicJobOptions {
        changeDelay?: (id: string, delay: number) => Promise<void>;
        changePriority?: (id: string, opts: ChangePriorityOpts) => Promise<void>;
        clearLogs?: (id: string, keepLogs?: number) => Promise<void>;
        discard?: (id: string) => void;
        extendLock?: (
            id: string,
            token: string,
            duration: number,
        ) => Promise<number>;
        getChildrenValues?: (id: string) => Promise<Record<string, unknown>>;
        getDependencies?: (
            id: string,
            opts?: GetDependenciesOpts,
        ) => Promise<JobDependencies>;
        getDependenciesCount?: (
            id: string,
            opts?: GetDependenciesOpts,
        ) => Promise<JobDependenciesCount>;
        getFailedChildrenValues?: (id: string) => Promise<Record<string, string>>;
        getIgnoredChildrenFailures?: (
            id: string,
        ) => Promise<Record<string, string>>;
        getState?: (id: string) => Promise<JobStateType>;
        job: Job;
        moveToCompleted?: (
            id: string,
            returnValue: unknown,
            token?: string,
        ) => Promise<unknown>;
        moveToDelayed?: (
            id: string,
            timestamp: number,
            token?: string,
        ) => Promise<void>;
        moveToFailed?: (id: string, error: Error, token?: string) => Promise<void>;
        moveToWait?: (id: string, token?: string) => Promise<boolean>;
        moveToWaitingChildren?: (
            id: string,
            token?: string,
            opts?: { child?: { id: string; queue: string } },
        ) => Promise<boolean>;
        name: string;
        promote?: (id: string) => Promise<void>;
        remove?: (id: string) => Promise<void>;
        removeChildDependency?: (id: string) => Promise<boolean>;
        removeDeduplicationKey?: (id: string) => Promise<boolean>;
        removeUnprocessedChildren?: (id: string) => Promise<void>;
        retry?: (id: string) => Promise<void>;
        stacktrace?: string[] | null;
        updateData?: (id: string, data: unknown) => Promise<void>;
        waitUntilFinished?: (
            id: string,
            queueEvents: unknown,
            ttl?: number,
        ) => Promise<unknown>;
    }
    Index
    changeDelay?: (id: string, delay: number) => Promise<void>
    changePriority?: (id: string, opts: ChangePriorityOpts) => Promise<void>
    clearLogs?: (id: string, keepLogs?: number) => Promise<void>
    discard?: (id: string) => void
    extendLock?: (id: string, token: string, duration: number) => Promise<number>
    getChildrenValues?: (id: string) => Promise<Record<string, unknown>>
    getDependencies?: (
        id: string,
        opts?: GetDependenciesOpts,
    ) => Promise<JobDependencies>
    getDependenciesCount?: (
        id: string,
        opts?: GetDependenciesOpts,
    ) => Promise<JobDependenciesCount>
    getFailedChildrenValues?: (id: string) => Promise<Record<string, string>>
    getIgnoredChildrenFailures?: (id: string) => Promise<Record<string, string>>
    getState?: (id: string) => Promise<JobStateType>
    job: Job
    moveToCompleted?: (
        id: string,
        returnValue: unknown,
        token?: string,
    ) => Promise<unknown>
    moveToDelayed?: (id: string, timestamp: number, token?: string) => Promise<void>
    moveToFailed?: (id: string, error: Error, token?: string) => Promise<void>
    moveToWait?: (id: string, token?: string) => Promise<boolean>
    moveToWaitingChildren?: (
        id: string,
        token?: string,
        opts?: { child?: { id: string; queue: string } },
    ) => Promise<boolean>
    name: string
    promote?: (id: string) => Promise<void>
    remove?: (id: string) => Promise<void>
    removeChildDependency?: (id: string) => Promise<boolean>
    removeDeduplicationKey?: (id: string) => Promise<boolean>
    removeUnprocessedChildren?: (id: string) => Promise<void>
    retry?: (id: string) => Promise<void>
    stacktrace?: string[] | null
    updateData?: (id: string, data: unknown) => Promise<void>
    waitUntilFinished?: (
        id: string,
        queueEvents: unknown,
        ttl?: number,
    ) => Promise<unknown>