Functions — github.com/taskforcesh/bullmq

hub / github.com/taskforcesh/bullmq / functions

Functions3,768 in github.com/taskforcesh/bullmq

⨍ Functions 3,768◇ Types & classes 487↳ Endpoints 8

* Shapes a job-claim result (from `move_to_active` or the fused finish+fetch) * into the worker's `[jobData, id, rateLimitDelay, delayUntil]` tuple

src/postgres/postgres-queue-backend.ts:778

↓ 3 callersMethodcancelJob

Cancel a specific in-flight job by aborting its `AbortSignal`. Returns True if the job is tracked and an `AbortController` was

python/bullmq/worker.py:632

↓ 3 callersMethodcancelJob

* Cancels a specific job currently being processed by this worker. * The job's processor function will receive an abort signal. * * @param jo

src/classes/worker.ts:521

↓ 3 callersMethodclient

(command: 'LIST')

src/classes/queue-getters.ts:13

↓ 3 callersMethodclientList

()

src/interfaces/redis-client.ts:224

↓ 3 callersMethodclientSetName

(name: string)

src/classes/node-redis-client.ts:167

↓ 3 callersMethodconnect

()

src/classes/bun-redis-client.ts:339

↓ 3 callersFunctioncreatePostgresBackend

( name, opts, factoryOpts = {}, )

src/postgres/create-postgres-backend.ts:25

↓ 3 callersFunctioncreate_backend

Build the datastore backend selected by ``opts``. Selects the PostgreSQL adapter when ``opts["backend"] == "postgres"``, otherwise the defaul

python/bullmq/backends/__init__.py:12

↓ 3 callersMethodcursor

(self)

python/tests/postgres_backend_test.py:128

↓ 3 callersMethodcustomCommand

(args: GlideArg[])

src/classes/valkey-glide-client.ts:44

↓ 3 callersFunctiondecreaseMaxListeners

( emitter: { getMaxListeners(): number; setMaxListeners(n: number): any }, count: number, )

src/utils/index.ts:174

↓ 3 callersFunctiondefault_repeat_strategy

Resolve the next iteration timestamp (in epoch millis) for a cron `pattern`. Returns None if no pattern is set. Mirrors the Node `defaul

python/bullmq/job_scheduler.py:64

↓ 3 callersMethoddelay

* * This function is exposed only for testing purposes.

src/classes/worker.ts:886

↓ 3 callersMethodduplicate

()

src/classes/bun-redis-client.ts:94

↓ 3 callersMethodencodeOpts

Encode options keys from long form to short form for Redis storage. For example: 'deduplication' -> 'de', 'failParentOnFailure' -> 'f

python/bullmq/scripts.py:51

↓ 3 callersMethodensure_loaded

Ensure the named scripts are loaded into Redis using SCRIPT LOAD. This is intended for pipelined operations where EVALSHA must succeed without a NOSC

rust/src/scripts.rs:108

↓ 3 callersMethodeval

( lua: string, options: { keys: string[]; arguments: NodeRedisCommandArgument[] }, )

src/classes/node-redis-client.ts:84

↓ 3 callersMethodexecScriptOnTransaction

* Queue a Lua script execution on a transaction. * * @param mixed $transaction The Predis transaction * @param string $scriptName

php/src/Scripts.php:109

↓ 3 callersFunctionflattenFieldPairs

(fields: unknown)

src/classes/valkey-glide-client.ts:146

↓ 3 callersMethodget

(key: string)

src/classes/node-redis-client.ts:98

↓ 3 callersMethodgetActiveCount

* Returns the number of jobs in active status.

src/classes/queue-getters.ts:296

↓ 3 callersMethodgetAllFree

()

src/classes/child-pool.ts:126

↓ 3 callersMethodgetCompleted

* Get completed jobs. * * @param int $start Start index * @param int $end End index * @return array<Job> */

php/src/Queue.php:430

↓ 3 callersMethodgetFree

(id: string)

src/classes/child-pool.ts:122

↓ 3 callersMethodgetGlobalRateLimit

Returns `{"max": int, "duration": int}` if a global rate limit is configured, otherwise None.

python/bullmq/queue.py:164

↓ 3 callersMethodgetJobCounts

* Returns the job counts for each type specified or every list/set in the queue by default. * @param types - the types of jobs to count. If not spe

src/classes/queue-getters.ts:181

↓ 3 callersMethodgetKeys

(name: string)

src/classes/queue-keys.ts:6

↓ 3 callersMethodgetPrioritizedCount

* Returns the number of jobs in prioritized status.

src/classes/queue-getters.ts:303

↓ 3 callersMethodgetQueueMetaField

* Reads a single queue metadata field.

src/interfaces/queue-backend.ts:688

↓ 3 callersMethodgetRanges

( types: JobType[], start?: number, end?: number, asc?: boolean, )

src/interfaces/queue-backend.ts:613

↓ 3 callersMethodget_deduplication_job_id

Get the job ID stored for a given deduplication ID. Returns `None` if no deduplication key exists.

rust/src/queue.rs:2132

↓ 3 callersMethodget_job_counts_by_types

Return the job counts for each provided type, keyed by type name. An empty `types` slice returns counts for every queryable state.

rust/src/queue.rs:1113

↓ 3 callersMethodget_job_logs

Get logs for a specific job. Returns the log entries and total count.

rust/src/queue.rs:2182

↓ 3 callersMethodget_meta

Return the queue's public metadata (read from the `meta` hash). Well-known numeric/boolean fields (`concurrency`, `max`, `duration`, `opts.maxLenEven

rust/src/queue.rs:1294

↓ 3 callersFunctionget_parent_key

(opts: dict[str, str])

python/bullmq/utils.py:27

↓ 3 callersMethodget_waiting

Return jobs in the `waiting` (and `paused`) state.

rust/src/queue.rs:1037

↓ 3 callersMethodhscan

( key: string, cursor: string | number, options?: { COUNT?: number }, )

src/interfaces/redis-client.ts:254

↓ 3 callersMethodisActive

Returns true if the job is active.

python/bullmq/job.py:176

↓ 3 callersMethodisActive

* @returns true if the job is active.

src/classes/job.ts:917

↓ 3 callersMethodisCompleted

* @returns true if the job has completed.

src/classes/job.ts:889

↓ 3 callersFunctionisIRedisClient

(obj: any)

src/classes/ioredis-client.ts:414

↓ 3 callersMethodisJobInState

* Returns whether a job id is present in the given state.

src/interfaces/queue-backend.ts:582

↓ 3 callersMethodisMaxed

* Returns whether the queue has reached its concurrency limit.

src/interfaces/queue-backend.ts:577

↓ 3 callersMethodisRateLimited

()

src/classes/worker.ts:784

↓ 3 callersMethodisReconnectingDisabled

( client: BlockingClusterClient, )

src/classes/redis-connection.ts:596

↓ 3 callersMethodloadCommand

( filename: string, dir: string, cache?: Map<string, ScriptMetadata>, isLoadingIncludes = fals

src/commands/script-loader.ts:408

↓ 3 callersMethodloadScripts

* Load redis lua scripts. * The name of the script must have the following format: * * cmdName-numKeys.lua * * cmdName must be in camel

src/commands/script-loader.ts:463

↓ 3 callersMethodlpos

(key: string, value: string)

src/interfaces/redis-client.ts:145

↓ 3 callersMethodlpush

(key: string, ...values: string[])

src/classes/bun-redis-client.ts:1209

↓ 3 callersMethodltrim

(key: string, start: number, end: number)

src/interfaces/redis-client.ts:144

↓ 3 callersMethodnewPromise

()

src/classes/async-fifo-queue.ts:161

↓ 3 callersMethodnodes

Return connections for each cluster node (only when isCluster).

src/interfaces/redis-client.ts:241

↓ 3 callersFunctionnoop_processor

()

rust/tests/workers_test.rs:14

↓ 3 callersFunctionnotImplemented

* Marks an {@link IQueueBackend} operation that the PostgreSQL backend does not * implement yet. The full operation set is being filled in incrementa

src/postgres/postgres-queue-backend.ts:157

↓ 3 callersFunctionobjectToFlatArray

(obj: Record<string, any>)

src/utils/index.ts:70

↓ 3 callersFunctionobject_to_flat_array

Converts a dictionary into a flat array where each key is followed by its value. Args: obj (dict[str, Any]): The input dictionary to

python/bullmq/utils.py:34

↓ 3 callersFunctionoptsAsJSON

* Encodes public job options ({@link JobsOptions}) into their compact, stored * form (short keys) before they are packed and persisted in Redis. Inte

src/classes/redis-queue-backend.ts:3063

↓ 3 callersFunctionopts_with_certs

(certs: TlsCerts)

rust/src/redis_connection.rs:210

↓ 3 callersFunctionparse_client_list

Parse the output of Redis `CLIENT LIST` and return the info maps for clients belonging to this queue. Mirrors Node.js `QueueGetters.parseClientList`:

rust/src/queue.rs:2936

↓ 3 callersMethodping

Ping the server to verify connectivity.

rust/src/redis_connection.rs:112

↓ 3 callersMethodpostMessage

(message: any)

src/utils/index.ts:274

↓ 3 callersMethodquit

()

src/classes/node-redis-client.ts:76

↓ 3 callersFunctionquoteSchemaName

(schema: string)

src/postgres/migrator.ts:93

↓ 3 callersFunctionquote_schema_name

Validate a schema name and return it double-quoted for safe DDL.

python/bullmq/backends/postgres_connection.py:94

↓ 3 callersFunctionraw2NextJobData

(raw: list[Any])

python/bullmq/scripts.py:865

↓ 3 callersFunctionraw2NextJobData

(raw: any[])

src/classes/redis-queue-backend.ts:2927

↓ 3 callersFunctionrawToJobJson

* Decodes a raw Redis job hash ({@link JobJsonRaw}) into the public, datastore * agnostic representation ({@link JobJson}). This translates the abbre

src/classes/redis-queue-backend.ts:3012

↓ 3 callersMethodremoveDeprecatedPriorityKey

* Removes the deprecated priority helper key. * @returns The number of keys removed.

src/interfaces/queue-backend.ts:725

↓ 3 callersMethodremoveOrphanedJobs

* Removes orphaned job keys that exist in the datastore but are not * referenced by any queue state set. * @returns The total number of orphaned

src/interfaces/queue-backend.ts:421

↓ 3 callersMethodremoveQueueMetaFields

* Removes one or more queue metadata fields.

src/interfaces/queue-backend.ts:703

↓ 3 callersMethodremove_global_rate_limit

Remove global rate limit values from queue meta.

rust/src/queue.rs:2015

↓ 3 callersMethodrepeat

(&self)

rust/src/keys.rs:182

↓ 3 callersMethodresolvePath

* Resolve the script path considering path mappings * @param scriptName - the name of the script * @param stack - the include stack, for nicer e

src/commands/script-loader.ts:144

↓ 3 callersMethodretryJob

* Retries a failed/active job immediately by pushing it back to wait.

src/interfaces/queue-backend.ts:343

↓ 3 callersMethodretry_jobs

Retry all failed (or completed) jobs, moving them back to wait. - `state`: "failed" or "completed" (default: "failed") - `count`: max jobs to move pe

rust/src/queue.rs:1845

↓ 3 callersMethodreturnvalue

The return value from processing.

rust/src/job.rs:222

↓ 3 callersFunctionrowToJobJson

* Maps a `job` row to the public {@link JobJson} shape consumed by * `Job.fromJSON`. JSON-string fields (`data`, `returnvalue`, `stacktrace`) are *

src/postgres/postgres-queue-backend.ts:121

↓ 3 callersMethodsadd

(key: string, ...members: (string | number)[])

src/classes/bun-redis-client.ts:1201

↓ 3 callersFunctionserialize_progress_for_script

(progress: &crate::types::JobProgress)

rust/src/queue.rs:2965

↓ 3 callersMethodset_application_name

(self, name: str)

python/bullmq/backends/postgres_connection.py:271

↓ 3 callersMethodset_client_name

(self, name: str)

python/bullmq/redis_connection.py:164

↓ 3 callersFunctionsplitFilename

(filePath: string)

src/commands/script-loader.ts:591

↓ 3 callersMethodsscan

( key: string, cursor: string | number, options?: { COUNT?: number }, )

src/interfaces/redis-client.ts:262

↓ 3 callersMethodtoKey

* Get the key for a specific type. */

php/src/Scripts.php:53

↓ 3 callersMethodtrimEvents

* Trims the event stream to an approximate maximum length. * @returns The number of entries removed.

src/interfaces/queue-backend.ts:731

↓ 3 callersMethodupdateJobSchedulerNextMillis

( jobSchedulerId: string, nextMillis: number, templateData: string, delayedJobOpts: JobsOption

src/interfaces/queue-backend.ts:520

↓ 3 callersMethodwaitForJob

Wait for claimable work and return a Redis-like marker tuple. Returns ``["bullmq_jobs", queue_name, 0]`` when work is immediately cla

python/bullmq/backends/postgres_backend.py:774

↓ 3 callersFunctionwait_for_failed

Wait for the next `Failed` worker event and return its error message.

rust/tests/worker_options_test.rs:39

↓ 3 callersMethodwait_until_ready

(self)

python/bullmq/backends/postgres_connection.py:189

↓ 3 callersMethodzRange

( key: string, start: number, end: number, options?: Record<string, unknown>, )

src/classes/node-redis-client.ts:106

↓ 2 callersMethodAddJobsAsync

(IReadOnlyList<Job> jobs)

dotnet/src/BullMQ/RedisBackend.cs:158

↓ 2 callersMethodAddLogAsync

(string jobId, string logRow, int keepLogs = 0)

dotnet/src/BullMQ/RedisBackend.cs:746

↓ 2 callersMethodCloseAsync

()

dotnet/src/BullMQ/Postgres/PostgresConnection.cs:524

↓ 2 callersMethodCreate

<summary>Creates a PostgreSQL backend from the given options.</summary>

dotnet/src/BullMQ/PostgresBackend.cs:52

↓ 2 callersMethodFromIdAsync

<summary>Fetches a job by id, or null when it does not exist.</summary>

dotnet/src/BullMQ/Job.cs:146

↓ 2 callersMethodFromWireString

(string? value)

dotnet/src/BullMQ/JobState.cs:34

↓ 2 callersMethodGet

(string key)

dotnet/src/BullMQ/JobJson.cs:44

↓ 2 callersMethodGetDelayedCountAsync

<summary>Returns the number of delayed jobs.</summary>

dotnet/src/BullMQ/Queue.cs:249

↓ 2 callersMethodGetJobLogsAsync

<summary>Returns a page of a job's logs together with the total count.</summary>

dotnet/src/BullMQ/Queue.cs:253

← previous next →401–500 of 3,768, ranked by callers