Type alias RedisJobProOptions

RedisJobProOptions: RedisJobOptions & {
    group?: {
        id: string;
        maxSize?: number;
        priority?: number;
    };
}

These fields are the ones stored in Redis with smaller keys for compactness.

Type declaration

  • Optional group?: {
        id: string;
        maxSize?: number;
        priority?: number;
    }
    • id: string

      The group id. If the group does not exist it will be created. (When the group becomes empty it will be deleted automatically)

    • Optional maxSize?: number

      The maximum number of jobs that can be added to a group. If the limit has been reached an error with the type GroupMaxSizeExceededError will be thrown.

    • Optional priority?: number

      Ranges from 1 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.

Generated using TypeDoc