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

  • InterimFlowProducer
    • FlowProducer

Constructors

constructor

Properties

closing keys opts queueKeys toKey

Accessors

client

Methods

add addBulk close disconnect emit getFlow off on once

Constructors

constructor

  • Parameters

    • opts: QueueBaseOptions = {}

    Returns FlowProducer

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

opts

opts: QueueBaseOptions = {}

queueKeys

queueKeys: QueueKeys

toKey

toKey: ((name, type) => string)

Type declaration

    • (name, type): string

    • Parameters

      • name: string
      • type: string

      Returns string

Accessors

client

  • get client(): Promise<RedisClient>

  • Returns Promise<RedisClient>

Methods

add

  • 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: FlowJobPro

      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<JobNodePro>

addBulk

  • 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

  • Returns Promise<void>

disconnect

  • Returns Promise<void>

emit

  • Type Parameters

    • U extends keyof FlowProducerListener

    Parameters

    • event: U
    • Rest ...args: Parameters<FlowProducerListener[U]>

    Returns boolean

getFlow

  • Get a flow.

    Parameters

    • opts: NodeOpts

      an object with options for getting a JobNode.

    Returns Promise<JobNode>

off

  • Type Parameters

    • U extends keyof FlowProducerListener

    Parameters

    • eventName: U
    • listener: FlowProducerListener[U]

    Returns FlowProducer

on

  • Type Parameters

    • U extends keyof FlowProducerListener

    Parameters

    • event: U
    • listener: FlowProducerListener[U]

    Returns FlowProducer

once

  • Type Parameters

    • U extends keyof FlowProducerListener

    Parameters

    • event: U
    • listener: FlowProducerListener[U]

    Returns FlowProducer

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc