@taskforcesh/bullmq-pro - v7.35.2
    Preparing search index...

    Class QueuePro<DataType, ResultType, NameType>

    Type Parameters

    • DataType = any
    • ResultType = any
    • NameType extends string = string

    Hierarchy

    Index

    Constructors

    Methods

    • Cleans all the jobs that are part of a group.

      Parameters

      • groupId: string | number

      Returns Promise<void>

    • Cleans all the groups in this queue

      Returns Promise<void>

    • Get jobs that are part of a given group.

      Parameters

      • groupId: string | number
      • start: number = 0
      • end: number = -1

      Returns Promise<Job<any, any, string>[]>

    • Gets the count of jobs inside a given group id.

      Parameters

      • groupId: string | number

      Returns Promise<any>

    • Get the group ids with jobs current jobs in them.

      TODO: Support group id filtering.

      Parameters

      • start: number = 0
      • end: number = -1

      Returns Promise<string[]>

    • Get the the number of groups with jobs in them.

      Returns Promise<number>

    • Gets the count of all the jobs belonging to any group.

      Returns Promise<number>

    • Completely destroys the queue and all of its contents irreversibly. This method will the pause the queue and requires that there are no active jobs. It is possible to bypass this requirement, i.e. not having active jobs using the "force" option.

      Note: This operation requires to iterate on all the jobs stored in the queue and can be slow for very large queues.

      Parameters

      • Optionalopts: { count?: number; force?: boolean }

        Obliterate options.

      Returns Promise<void>