Class FlowProducer

constructor

• new FlowProducer(opts?, Connection?): FlowProducer

• Parameters

  • opts: QueueBaseOptions = ...
  • Connection: typeof RedisConnection = RedisConnection

  Returns FlowProducer

closing

keys

opts

queueKeys

toKey

client

• get client(): Promise<RedisClient>

• Returns a promise that resolves to a redis client. Normally used only by subclasses.

  Returns Promise<RedisClient>

add

• add(flow, opts?): Promise<JobNode>

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

addBulk

• addBulk(flows): 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

• close(): Promise<void>

• Closes the connection and returns a promise that resolves when the connection is closed.

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Force disconnects a connection.

  Returns Promise<void>

emit

• emit<U>(event, ...args): boolean

• Type Parameters

  • U extends keyof FlowProducerListener

  Parameters

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

  Returns boolean

getFlow

• getFlow(opts): Promise<JobNode>

• Get a flow.

  Parameters

  • opts: NodeOpts

    an object with options for getting a JobNode.

  Returns Promise<JobNode>

off

• off<U>(eventName, listener): this

• Type Parameters

  • U extends keyof FlowProducerListener

  Parameters

  • eventName: U
  • listener: FlowProducerListener[U]

  Returns this

on

• on<U>(event, listener): this

• Type Parameters

  • U extends keyof FlowProducerListener

  Parameters

  • event: U
  • listener: FlowProducerListener[U]

  Returns this

once

• once<U>(event, listener): this

• Type Parameters

  • U extends keyof FlowProducerListener

  Parameters

  • event: U
  • listener: FlowProducerListener[U]

  Returns this

waitUntilReady

• waitUntilReady(): Promise<RedisClient>

• Returns Promise<RedisClient>