> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/taskforcesh/bullmq/llms.txt > Use this file to discover all available pages before exploring further. # QueueGetters > Provides getters for different aspects of a queue ## Overview The QueueGetters class provides various getter methods for retrieving information about jobs, counts, and queue state. The Queue class extends QueueGetters, so all these methods are available on Queue instances. You typically don't instantiate QueueGetters directly. Use the Queue class which inherits these methods. ## Methods ### getJob Fetches a job by its ID. ```typescript theme={null} getJob(jobId: string): Promise ``` The job ID to fetch ### count Returns the number of jobs waiting to be processed. ```typescript theme={null} count(): Promise ``` Total count of waiting, paused, delayed, prioritized, and waiting-children jobs ### getJobCounts Returns the job counts for each type specified. ```typescript theme={null} getJobCounts(...types: JobType[]): Promise<{ [index: string]: number }> ``` Job types to count (e.g., 'waiting', 'active', 'completed', 'failed') ```typescript theme={null} const counts = await queue.getJobCounts('waiting', 'active', 'completed'); // { waiting: 5, active: 2, completed: 100 } ``` ### getJobCountByTypes Returns the total count for specified job types. ```typescript theme={null} getJobCountByTypes(...types: JobType[]): Promise ``` ### getCompletedCount Returns the number of jobs in completed status. ```typescript theme={null} getCompletedCount(): Promise ``` ### getFailedCount Returns the number of jobs in failed status. ```typescript theme={null} getFailedCount(): Promise ``` ### getDelayedCount Returns the number of jobs in delayed status. ```typescript theme={null} getDelayedCount(): Promise ``` ### getActiveCount Returns the number of jobs in active status. ```typescript theme={null} getActiveCount(): Promise ``` ### getWaitingCount Returns the number of jobs in waiting or paused status. ```typescript theme={null} getWaitingCount(): Promise ``` ### getWaitingChildrenCount Returns the number of jobs in waiting-children status. ```typescript theme={null} getWaitingChildrenCount(): Promise ``` ### getPrioritizedCount Returns the number of jobs in prioritized status. ```typescript theme={null} getPrioritizedCount(): Promise ``` ### getCountsPerPriority Returns the number of jobs per priority level. ```typescript theme={null} getCountsPerPriority(priorities: number[]): Promise<{ [index: string]: number }> ``` Array of priority values to check ```typescript theme={null} const counts = await queue.getCountsPerPriority([0, 1, 2]); // { '0': 10, '1': 5, '2': 3 } ``` ### getJobs Returns jobs on the given statuses. ```typescript theme={null} getJobs( types?: JobType[], start?: number, end?: number, asc?: boolean ): Promise ``` Job statuses to retrieve Zero-based index from where to start Zero-based index where to stop If true, return in ascending order ### getWaiting Returns jobs in waiting status. ```typescript theme={null} getWaiting(start?: number, end?: number): Promise ``` ### getWaitingChildren Returns jobs in waiting-children status. ```typescript theme={null} getWaitingChildren(start?: number, end?: number): Promise ``` ### getActive Returns jobs in active status. ```typescript theme={null} getActive(start?: number, end?: number): Promise ``` ### getDelayed Returns jobs in delayed status. ```typescript theme={null} getDelayed(start?: number, end?: number): Promise ``` ### getPrioritized Returns jobs in prioritized status. ```typescript theme={null} getPrioritized(start?: number, end?: number): Promise ``` ### getCompleted Returns jobs in completed status. ```typescript theme={null} getCompleted(start?: number, end?: number): Promise ``` ### getFailed Returns jobs in failed status. ```typescript theme={null} getFailed(start?: number, end?: number): Promise ``` ### getJobLogs Returns the logs for a given job. ```typescript theme={null} getJobLogs( jobId: string, start?: number, end?: number, asc?: boolean ): Promise<{ logs: string[]; count: number }> ``` The job ID to get logs for Start index End index Return in ascending order ### getJobState Gets the current state of a job. ```typescript theme={null} getJobState(jobId: string): Promise ``` One of: 'completed', 'failed', 'delayed', 'active', 'waiting', 'waiting-children', 'unknown' ### getDependencies Returns the dependencies of a parent job. ```typescript theme={null} getDependencies( parentId: string, type: 'processed' | 'pending', start: number, end: number ): Promise<{ items: { id: string; v?: any; err?: string }[]; jobs: JobJsonRaw[]; total: number; }> ``` ### getMeta Returns the global queue configuration. ```typescript theme={null} getMeta(): Promise ``` ### getGlobalConcurrency Gets the global concurrency value. ```typescript theme={null} getGlobalConcurrency(): Promise ``` ### getGlobalRateLimit Gets the global rate limit values. ```typescript theme={null} getGlobalRateLimit(): Promise<{ max: number; duration: number } | null> ``` ### getRateLimitTtl Returns the time to live for a rate limited key. ```typescript theme={null} getRateLimitTtl(maxJobs?: number): Promise ``` -2 if key does not exist, -1 if key exists but has no expire, otherwise TTL in milliseconds ### getDeduplicationJobId Gets the job ID from deduplicated state. ```typescript theme={null} getDeduplicationJobId(id: string): Promise ``` Deduplication identifier ### getWorkers Gets the worker list related to the queue. ```typescript theme={null} getWorkers(): Promise> ``` ### getWorkersCount Returns the current count of workers for the queue. ```typescript theme={null} getWorkersCount(): Promise ``` ### getMetrics Gets queue metrics. ```typescript theme={null} getMetrics( type: 'completed' | 'failed', start?: number, end?: number ): Promise ``` Metric type: 'completed' or 'failed' Start point (0 is newest) End point (-1 is oldest) ### exportPrometheusMetrics Exports metrics in Prometheus format. ```typescript theme={null} exportPrometheusMetrics( globalVariables?: Record ): Promise ``` Additional labels to include in metrics ```typescript theme={null} const metrics = await queue.exportPrometheusMetrics({ service: 'my-service', environment: 'production', }); console.log(metrics); // # HELP bullmq_job_count Number of jobs in the queue by state // # TYPE bullmq_job_count gauge // bullmq_job_count{queue="myQueue", state="waiting", service="my-service", environment="production"} 5 ``` ## JobType Valid job types/states: * `'active'` - Currently being processed * `'waiting'` - Waiting to be processed * `'completed'` - Successfully completed * `'failed'` - Failed after all attempts * `'delayed'` - Scheduled for future processing * `'paused'` - In a paused queue * `'prioritized'` - Waiting with priority * `'waiting-children'` - Waiting for child jobs to complete