Beignet API reference
    Preparing search index...

    Type Alias BullMQJobWorkerHealth

    BullMQJobWorkerHealth:
        | { ok: true; paused: false; queueName: string; running: true }
        | {
            error: { message: string; name?: string };
            ok: false;
            paused: boolean;
            queueName: string;
            running: boolean;
        }

    Readiness snapshot returned by a BullMQ worker handle.

    Type Declaration

    • { ok: true; paused: false; queueName: string; running: true }
      • ok: true

        Whether the worker is ready to accept work.

      • paused: false

        A ready worker is not locally paused.

      • queueName: string

        BullMQ queue consumed by the worker.

      • running: true

        A ready worker's processing loop is running.

    • {
          error: { message: string; name?: string };
          ok: false;
          paused: boolean;
          queueName: string;
          running: boolean;
      }
      • error: { message: string; name?: string }

        Connection or lifecycle failure that made the worker unready.

        • message: string

          Human-readable readiness failure.

        • Optionalname?: string

          Error class name when the failure was an Error.

      • ok: false

        Whether the worker is ready to accept work.

      • paused: boolean

        Whether the worker is locally paused.

      • queueName: string

        BullMQ queue consumed by the worker.

      • running: boolean

        Whether the worker's processing loop is running.