@vhidvz/wfjs
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    $: { attachedToRef?: string; id: string; name?: string }
    context?: Context<any>
    key?: string
    process: BPMNProcess
    token?: Token

    Accessors

    • get eventDefinitionType(): EventDefinitionType | undefined

      If the event definition is a link event definition, return the link event definition type, otherwise if it's a timer event definition, return the timer event definition type, otherwise if it's an error event definition, return the error event definition type, otherwise if it's a signal event definition, return the signal event definition type, otherwise if it's a message event definition, return the message event definition type, otherwise if it's an escalation event definition, return the escalation event definition type, otherwise if it's a conditional event definition, return the conditional event definition type, otherwise if it's a compensation event definition, return the compensation event definition type

      Returns EventDefinitionType | undefined

      The type of the event definition.

    • get id(): string

      The function returns the value of the id property of the object that is stored in the $ property of the current object

      Returns string

      The id property of the object.

    • get incoming(): Sequence[]

      The incoming property returns an array of Sequence objects that are incoming to the current Activity

      Returns Sequence[]

      An array of Sequence objects.

    • get intermediateType(): Throw | Catch | undefined

      If the key contains the word "throw", return "Throw", otherwise if the key contains the word "catch", return "Catch"

      Returns Throw | Catch | undefined

      The intermediateType property is being returned.

    • get name(): string | undefined

      The function returns the value of the name property of the object that is stored in the $ property of the current object

      Returns string | undefined

      The name property of the object.

    • get outgoing(): Sequence[]

      It returns an array of Sequence objects that are outgoing from the current activity

      Returns Sequence[]

      An array of Sequence objects

    • get type(): End | Start | Boundary | Intermediate | undefined

      If the event is attached to a reference, it's a boundary event. If the event's key contains the word "end", it's an end event. If the event's key contains the word "start", it's a start event. If the event's key contains the word "intermediate", it's an intermediate event. If none of the above are true, it's a start event

      Returns End | Start | Boundary | Intermediate | undefined

      The type of the event.

    Methods

    • The function handles outgoing transitions for a token in a workflow system.

      Parameters

      • outgoing: GoOutInterface[]

        outgoing is an array of objects of type GoOutInterface. Each object represents an outgoing transition from a current activity to a new activity.

      Returns Token[] | undefined

    • If the key property of the current node is not null and includes the string 'endEvent', return true

      Returns boolean | undefined

      The key of the current node.

    • If the key property exists and includes the string 'startEvent', return true. Otherwise, return false

      Returns boolean | undefined

      A boolean value.

    • It takes the outgoing sequence flows from the current activity and creates a new token for each one

      Parameters

      • Optionalidentity: IdentityOptions

        IdentityOptions

      • Optionaloptions: { pause: string | boolean }

        pause: boolean | string

      Returns Token[] | undefined

      The outgoing activity

    • The function takes an array of options, retrieves corresponding activities from an outgoing array, and passes them to another function.

      Parameters

      • options: TakeOutgoingInterface[]

        An array of objects with two properties: "identity" and "pause". "identity" is a string representing the identity of the outgoing activity to be taken out, and "pause" is a boolean indicating whether the activity should be paused or not.

      Returns Token[] | undefined

      If the outgoing property is falsy or an empty array, nothing is returned.