Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FlowProducer

This class allows to add jobs with dependencies between them in such a way that it is possible to build complex flows. Note: A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent will be processed, being able to access the children's result data. All Jobs can be in different queues, either children or parents,

Hierarchy

  • EventEmitter
    • FlowProducer

Index

Constructors

Properties

closing: Promise<void>
keys: KeysMap
opts: QueueBaseOptions = {}
queueKeys: QueueKeys
toKey: (name: string, type: string) => string

Type declaration

    • (name: string, type: string): string
    • Parameters

      • name: string
      • type: string

      Returns string

Accessors

Methods

  • Adds a flow.

    This call would be atomic, either it fails and no jobs will be added to the queues, or it succeeds and all jobs will be added.

    Parameters

    • flow: FlowJob

      an object with a tree-like structure where children jobs will be processed before their parents.

    • Optional opts: FlowOpts

      options that will be applied to the flow object.

    Returns Promise<JobNode>

  • Adds multiple flows.

    A flow is a tree-like structure of jobs that depend on each other. Whenever the children of a given parent are completed, the parent will be processed, being able to access the children's result data.

    All Jobs can be in different queues, either children or parents, however this call would be atomic, either it fails and no jobs will be added to the queues, or it succeeds and all jobs will be added.

    Parameters

    • flows: FlowJob[]

      an array of objects with a tree-like structure where children jobs will be processed before their parents.

    Returns Promise<JobNode[]>

  • close(): Promise<void>
  • disconnect(): Promise<void>

Generated using TypeDoc