Class SQLiteQueueAdapter

Blueprint for Queue messaging adapters (AMQP, SQS, PubSub, etc.).

Hierarchy (View Summary)

AbstractQueueAdapter
- SQLiteQueueAdapter

Index

Constructors

Properties

_client _connection _dbPath _intervals _params

Methods

_connect deleteTask getTasks listen retryTask send updateProgress

Constructors

constructor

new SQLiteQueueAdapter(params: any): SQLiteQueueAdapter
Parameters
- params: any
Returns SQLiteQueueAdapter
Overrides AbstractQueueAdapter.constructor
- Defined in queue-sqlite/src/SQLiteQueueAdapter.ts:11

Properties

`Protected`_client

_client: any

`Protected`_connection

_connection: Database<Database, Statement> | undefined

`Protected`_dbPath

_dbPath: string

`Protected`_intervals

_intervals: Map<string, Timeout> = ...

`Protected`_params

_params: QueueParameters

Methods

`Protected`_connect

_connect(): Promise<Database<Database, Statement>>
Returns Promise<Database<Database, Statement>>
- Defined in queue-sqlite/src/SQLiteQueueAdapter.ts:16

deleteTask

deleteTask(taskId: string): Promise<boolean>
Deletes a task from the queue database.
Parameters
- taskId: string
Returns Promise<boolean>
- Defined in queue-sqlite/src/SQLiteQueueAdapter.ts:189

getTasks

getTasks(topic?: string): Promise<any[]>
Returns all tasks in the queue sorted by created_at DESC.
Parameters
- Optionaltopic: string
Returns Promise<any[]>
- Defined in queue-sqlite/src/SQLiteQueueAdapter.ts:135

listen

listen(
    topic: string,
    handler: Function,
    params?: { concurrency?: number; gpu?: boolean },
): any
Listens for pending tasks on a topic and runs the handler.
Parameters
- topic: string
- handler: Function
- Optionalparams: { concurrency?: number; gpu?: boolean }
Returns any
Overrides AbstractQueueAdapter.listen
- Defined in queue-sqlite/src/SQLiteQueueAdapter.ts:62

retryTask

retryTask(taskId: string): Promise<boolean>
Retries a failed or stuck processing task by setting its status back to pending.
Parameters
- taskId: string
Returns Promise<boolean>
- Defined in queue-sqlite/src/SQLiteQueueAdapter.ts:174

send

send(data: any, topic: string): Promise<string>
Dispatches a task payload into SQLite queue messages table.
Parameters
- data: any
- topic: string
Returns Promise<string>
Overrides AbstractQueueAdapter.send
- Defined in queue-sqlite/src/SQLiteQueueAdapter.ts:44

updateProgress

updateProgress(taskId: string, progress: number): Promise<void>
Helper to update running task progress.
Parameters
- taskId: string
- progress: number
Returns Promise<void>
- Defined in queue-sqlite/src/SQLiteQueueAdapter.ts:201