Options
All
  • Public
  • Public/Protected
  • All
Menu

conveyor-mq

Enumerations

Interfaces

Variables

Functions

Variables

Const debug

debug: Debugger = debugF('conveyor-mq:orchestrator')

Functions

Const createListener

  • createListener(__namedParameters: object): object

  • Creates a listener which listens for various task, queue and worker related events.

    Parameters

    • __namedParameters: object
      • events: undefined | EventType[]
      • queue: string
      • redisConfig: object
        • host: string
        • port: number

    Returns object

    listener

    • .onReady(): Promise - A function which returns a promise that resolves when the listener is ready.
    • .on(eventName, handler): void - A function which registers a handler function for a particular event.
    • .quit(): Promise - Quits the listener, disconnects the redis client and removes all handlers.
    • on: function
      • on(eventType: EventType, f: function): void

      • Parameters

        • eventType: EventType
        • f: function
            • (__namedParameters: object): any

            • Parameters

              • __namedParameters: object

              Returns any

        Returns void

    • onReady: function
      • onReady(): Promise<void>

      • Returns Promise<void>

    • quit: function
      • quit(): Promise<void>

      • Returns Promise<void>

Const createManager

  • createManager(__namedParameters: object): object

  • Creates a manager which is responsible for enqueuing tasks, as well as querying various queue, task and worker properties.

    Parameters

    • __namedParameters: object
      • queue: string
      • redisConfig: object
        • host: string
        • port: number

    Returns object

    manager

    • .enqueueTask(task): Promise - Enqueues a task on the queue.
    • .enqueueTasks(tasks): Promise<Task[]> - Enqueues multiple tasks on the queue in a single transaction.
    • .scheduleTask(task): Promise - Schedules a task to be enqueued at a future date.
    • .scheduleTasks(tasks): Promise<Task[]> - Schedules multiple tasks in a single transaction.
    • .onTaskCompete(taskId): Promise - Returns a promise which resolves once the task is complete.
    • .getTaskById(taskId): Promise - Gets a task.
    • .getTasksById(taskIds): Promise<Task[]> - Gets a list of tasks in a single transaction.
    • .getTaskCounts(): Promise - Gets task counts by status.
    • .getWorkers(): Promise<Worker[]> - Gets workers on the queue.
    • .removeTaskById(taskId): Promise - Removes a task from the queue.
    • .destroyQueue(): Promise - Destroys the queue by removing all data & data structures.
    • .pauseQueue(): Promise - Pauses the queue.
    • .resumeQueue(): Promise - Resumes the queue.
    • .onReady(): Promise - Returns a promise which resolves once the manager is ready.
    • .quit(): Promise - Quits the manager, disconnects the redis clients.
      • destroyQueue: function
        • destroyQueue(): Promise<void>

        • Returns Promise<void>

      • enqueueTask: function

        • Parameters

          • task: Partial<Task>

          Returns Promise<TaskResponse>

      • enqueueTasks: function

        • Parameters

          • tasks: Partial<Task>[]

          Returns Promise<TaskResponse[]>

      • getTaskById: function
        • getTaskById(taskId: string): Promise<null | Task>

        • Parameters

          • taskId: string

          Returns Promise<null | Task>

      • getTaskCounts: function
        • getTaskCounts(): Promise<object>

        • Returns Promise<object>

      • getTasksById: function
        • getTasksById(taskIds: string[]): Promise<Task[]>

        • Parameters

          • taskIds: string[]

          Returns Promise<Task[]>

      • getWorkers: function
        • getWorkers(): Promise<Worker[]>

        • Returns Promise<Worker[]>

      • onReady: function
        • onReady(): Promise<void>

        • Returns Promise<void>

      • onTaskComplete: function
        • onTaskComplete(taskId: string): Promise<Task>

        • Parameters

          • taskId: string

          Returns Promise<Task>

      • pauseQueue: function
        • pauseQueue(): Promise<void>

        • Returns Promise<void>

      • quit: function
        • quit(): Promise<unknown>

        • Returns Promise<unknown>

      • removeTaskById: function
        • removeTaskById(taskId: string): Promise<void>

        • Parameters

          • taskId: string

          Returns Promise<void>

      • resumeQueue: function
        • resumeQueue(): Promise<void>

        • Returns Promise<void>

      • scheduleTask: function

        • Parameters

          • task: Partial<Task>

          Returns Promise<TaskResponse>

      • scheduleTasks: function

        • Parameters

          • tasks: Partial<Task>[]

          Returns Promise<TaskResponse[]>

      Const createOrchestrator

      • createOrchestrator(__namedParameters: object): object

      • Creates an orchestrator which is responsible for monitoring the queue for stalled tasks and re-enqueuing them if needed, as well as enqueuing scheduled tasks.

        Parameters

        • __namedParameters: object
          • defaultStallTimeout: number
          • queue: string
          • redisConfig: object
            • host: string
            • port: number
          • scheduledTasksCheckInterval: number
          • stalledCheckInterval: number

        Returns object

        orchestrator

        • .onReady(): Promise - Returns a promise that resolves when the orchestrator is ready.
        • .quit(): Promise - Quits the orchestrator, terminating all intervals and the redis client.
        • quit: quit
        • onReady: function
          • onReady(): Promise<void>

          • Returns Promise<void>

      Const createWorker

      • createWorker(__namedParameters: object): object

      • Creates a worker which processes tasks on the queue.

        Parameters

        • __namedParameters: object
          • autoStart: boolean
          • concurrency: number
          • defaultStallTimeout: number
          • defaultTaskAcknowledgementInterval: undefined | number
          • getRetryDelay: undefined | function
          • handler: function
              • (__namedParameters: object): any

              • Parameters

                • __namedParameters: object
                  • task: Task
                  • updateTask: function
                      • (taskUpdateData: Partial<Task>): Promise<Task>

                      • Parameters

                        • taskUpdateData: Partial<Task>

                        Returns Promise<Task>

                  • updateTaskProgress: function
                      • (progress: any): Promise<Task>

                      • Parameters

                        • progress: any

                        Returns Promise<Task>

                Returns any

          • idleTimeout: number
          • onHandlerError: undefined | function
          • onIdle: undefined | function
          • onReady: undefined | function
          • onTaskError: undefined | function
          • onTaskFailed: undefined | function
          • onTaskSuccess: undefined | function
          • queue: string
          • redisConfig: object
            • host: string
            • port: number
          • removeOnFailed: boolean
          • removeOnSuccess: boolean

        Returns object

        worker

        • .onReady(): Promise - A function which returns a promise that resolves when the worker is ready.
        • .pause(): Promise - Pauses the worker from processing tasks.
        • .start(): Promise - Starts the worker processing tasks.
        • .shutdown(): Promise - Shuts down the worker and disconnects redis clients.
        • .onIdle(): Promise - Returns a promise which resolves once the worker is idle.
        • onIdle: function
          • onIdle(): Promise<void>

          • Returns Promise<void>

        • onReady: function
          • onReady(): Promise<void>

          • Returns Promise<void>

        • pause: function
          • pause(killProcessingTasks?: undefined | false | true): Promise<void>

          • Parameters

            • Optional killProcessingTasks: undefined | false | true

            Returns Promise<void>

        • shutdown: function
          • shutdown(killProcessingTasks?: undefined | false | true): Promise<void>

          • Parameters

            • Optional killProcessingTasks: undefined | false | true

            Returns Promise<void>

        • start: function
          • start(): Promise<void>

          • Returns Promise<void>

      Generated using TypeDoc