Options
All
  • Public
  • Public/Protected
  • All
Menu

light-workflow-js

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActivityTask

ActivityTask: SWF.Types.ActivityTask

ActivityType

ActivityType: SWF.Types.ActivityType

Binding

Binding: object

Type declaration

ChildPolicy

ChildPolicy: "TERMINATE" | "REQUEST_CANCEL" | "ABANDON"

ClassLevelDecorator

ClassLevelDecorator: function

Type declaration

    • (constructor: Function): void
    • Parameters

      • constructor: Function

      Returns void

CompositeWorkflowEventParams

CompositeWorkflowEventParams: WorkflowExecutionStartedEventAttributes & WorkflowExecutionCanceledEventAttributes & WorkflowExecutionCancelRequestedEventAttributes & WorkflowExecutionCompletedEventAttributes & WorkflowExecutionContinuedAsNewEventAttributes & WorkflowExecutionFailedEventAttributes & WorkflowExecutionTerminatedEventAttributes & WorkflowExecutionTimedOutEventAttributes & CancelWorkflowExecutionFailedEventAttributes & CompleteWorkflowExecutionFailedEventAttributes

DecisionTask

DecisionTask: SWF.Types.DecisionTask

Decorator

Decorator: function

Type declaration

    • (target: any, propertyKey: string, descriptor: PropertyDescriptor): void
    • Parameters

      • target: any
      • propertyKey: string
      • descriptor: PropertyDescriptor

      Returns void

EventExpectation

EventExpectation: object

Type declaration

  • eventId: number
  • eventType: EventType
  • params: Partial<T>

HistoryEvent

HistoryEvent: SWF.Types.HistoryEvent

NameAndVersion

NameAndVersion: object

Type declaration

  • name: string
  • version: string

Newable

Newable: object

Type declaration

  • constructor: function
    • new __type(...args: any[]): T

PromiseOrObservable

PromiseOrObservable: Promise<R> | Observable<R>

RegisterWorkflowTypeInput

RegisterWorkflowTypeInput: SWF.Types.RegisterWorkflowTypeInput

Run

Run: SWF.Types.Run

ScheduleActivityTaskDecisionAttributes

ScheduleActivityTaskDecisionAttributes: SWF.Types.ScheduleActivityTaskDecisionAttributes

TransitionTable

TransitionTable: [T, T][]

ValueSetterDecoratorFactory

ValueSetterDecoratorFactory: function

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

WorkflowStartParameters

WorkflowStartParameters: SWF.Types.StartWorkflowExecutionInput

Variables

Const ACTIVITY_POLLER_FACTORY

ACTIVITY_POLLER_FACTORY: unique symbol = Symbol('ACTIVITY_POLLER_FACTORY')

Const ACTIVITY_RUN_CONTEXT

ACTIVITY_RUN_CONTEXT: unique symbol = Symbol('ACTIVITY_RUN_CONTEXT')

Const ACTIVITY_RUN_CONTEXT_ZONE_KEY

ACTIVITY_RUN_CONTEXT_ZONE_KEY: "ACTIVITY_RUN_CONTEXT_ZONE_KEY" = "ACTIVITY_RUN_CONTEXT_ZONE_KEY"

Const ACTOR_CLIENT_TAG

ACTOR_CLIENT_TAG: "actor-client" = "actor-client"

Const ACTOR_WORKER_FACTORY

ACTOR_WORKER_FACTORY: unique symbol = Symbol('ACTOR_WORKER_FACTORY')

Const APPLICATION_CONFIGURATION

APPLICATION_CONFIGURATION: unique symbol = Symbol('APPLICATION_CONFIGURATION')

Const APP_CONTAINER

APP_CONTAINER: unique symbol = Symbol('APP_KERNEL')

Const AWS_ADAPTER

AWS_ADAPTER: unique symbol = Symbol('AWS_ADAPTER')

Const AWS_SWF_NATIVE_CLIENT

AWS_SWF_NATIVE_CLIENT: unique symbol = Symbol('AWS_SWF_NATIVE_CLIENT')

Const CANCELLED_TRANSITION

CANCELLED_TRANSITION: EventType[] = [EventType.ActivityTaskScheduled,EventType.ActivityTaskStarted,EventType.ActivityTaskCancelRequested,EventType.ActivityTaskCanceled,]

Const CANCEL_FAILED_TRANSITION

CANCEL_FAILED_TRANSITION: EventType[] = [EventType.ActivityTaskScheduled,EventType.ActivityTaskStarted,EventType.ActivityTaskCancelRequested,EventType.RequestCancelActivityTaskFailed,]

Const COMPLETED_TRANSITION

COMPLETED_TRANSITION: EventType[] = [EventType.ActivityTaskScheduled,EventType.ActivityTaskStarted,EventType.ActivityTaskCompleted,]

Const CONTEXT_CACHE

CONTEXT_CACHE: unique symbol = Symbol('CONTEXT_CACHE')

Const CORE

CORE: ContainerModule = new ContainerModule((bind: interfaces.Bind) => {bind<AWSClientProvider>(AWS_ADAPTER).to(DefaultAWSClientProvider).inSingletonScope();bind<WorkflowClient>(WORKFLOW_CLIENT).to(BaseWorkflowClient).inSingletonScope();bind<ActivityPollerFactory>(ACTIVITY_POLLER_FACTORY).to(GenericActivityPollerFactory).inSingletonScope();bind<DecisionPollerFactory>(DECISION_POLLER_FACTORY).to(GenericDecisionPollerFactory).inSingletonScope();bind<ImplementationHelper>(IMPLEMENTATION_HELPER).to(BaseImplementationHelper).inSingletonScope();bind<WorkflowClientFactory>(WORKFLOW_REMOTE_CLIENT_FACTORY).to(BaseRemoteWorkflowClientFactory).inSingletonScope();bind<ActorProxyFactory>(REMOTE_ACTOR_PROXY_FACTORY).to(RemoteActorProxyFactory).inSingletonScope();bind<Workflows>(WORKFLOWS).to(BaseWorkflows).inSingletonScope();bind<UuidGenerator>(UUID_GENERATOR).to(BaseUuidGenerator).inSingletonScope();bind<WorkflowWorkerFactory>(WORKFLOW_WORKER_FACTORY).to(BaseWorkflowWorkerFactory).inSingletonScope();bind<ContextCache>(CONTEXT_CACHE).to(BaseContextCache).inSingletonScope();bind<ContextResolutionStrategy<DecisionRunContext>>(DECISION_CONTEXT_RESOLUTION).toConstantValue(new ZoneContextResolutionStrategy<DecisionRunContext>(DECISION_RUN_CONTEXT_ZONE_KEY));bind<RemoteActivityAdapterFactory>(REMOTE_ACTIVITY_ADAPTER_FACTORY).to(DefaultRemoteActivityAdapterFactory).inSingletonScope();bind<ActorWorkerFactory>(ACTOR_WORKER_FACTORY).to(BaseActorWorkerFactory).inSingletonScope();bind<Logger>(LOGGER).to(DefaultLogger).inRequestScope();})

Const DECISION_CONTEXT_RESOLUTION

DECISION_CONTEXT_RESOLUTION: unique symbol = Symbol('DECISION_CONTEXT_RESOLUTION')

Const DECISION_POLLER_FACTORY

DECISION_POLLER_FACTORY: unique symbol = Symbol('DECISION_POLLER_FACTORY')

Const DECISION_RUN_CONTEXT

DECISION_RUN_CONTEXT: unique symbol = Symbol('DECISION_RUN_CONTEXT')

Const DECISION_RUN_CONTEXT_ZONE_KEY

DECISION_RUN_CONTEXT_ZONE_KEY: "DECISION_RUN_CONTEXT_ZONE_KEY" = "DECISION_RUN_CONTEXT_ZONE_KEY"

Const DEFAULT_ACTOR_TASK_LIST

DEFAULT_ACTOR_TASK_LIST: "default" = "default"

Const DEFINITION_SYMBOL

DEFINITION_SYMBOL: unique symbol = Symbol('DEFINITION_SYMBOL')

Const FAILED_TRANSITION

FAILED_TRANSITION: EventType[] = [EventType.ActivityTaskScheduled,EventType.ActivityTaskStarted,EventType.ActivityTaskFailed,]

Const IMPLEMENTATION_HELPER

IMPLEMENTATION_HELPER: unique symbol = Symbol('IMPLEMENTATION_HELPER')

Const LOGGER

LOGGER: unique symbol = Symbol('LOGGER')

Const REMOTE_ACTIVITY_ADAPTER_FACTORY

REMOTE_ACTIVITY_ADAPTER_FACTORY: unique symbol = Symbol('REMOTE_ACTIVITY_ADAPTER_FACTORY')

Const REMOTE_ACTOR_PROXY_FACTORY

REMOTE_ACTOR_PROXY_FACTORY: unique symbol = Symbol('REMOTE_ACTOR_PROXY_FACTORY')

Const TASK_LIST_TAG

TASK_LIST_TAG: "task-list-tag" = "task-list-tag"

Const TEST_ACTOR

TEST_ACTOR: unique symbol = Symbol('TEST_ACTOR')

Const TEST_PROPERTY

TEST_PROPERTY: "testProperty" = "testProperty"

Const TEST_PROPERTY_2

TEST_PROPERTY_2: "testProperty2" = "testProperty2"

Const TEST_TRANSITION_TABLE

TEST_TRANSITION_TABLE: TransitionTable<TestStates> = [[TestStates.test1, TestStates.test2],[TestStates.test2, TestStates.test3],]

Const TEST_WF

TEST_WF: unique symbol = Symbol('TEST_WF')

Const TEST_WORKFLOW

TEST_WORKFLOW: unique symbol = Symbol('TEST_WORKFLOW')

Const TIMEOUTED_TRANSITION

TIMEOUTED_TRANSITION: EventType[] = [EventType.ActivityTaskScheduled,EventType.ActivityTaskStarted,EventType.ActivityTaskTimedOut,]

Const TRANSITION_TABLE

TRANSITION_TABLE: TransitionTable<WES> = [[WES.Created, WES.CanceledBeforeSent],[WES.Created, WES.Sending],[WES.Sending, WES.Sent],[WES.Sent, WES.CancelledAfterSent],[WES.Sent, WES.Started],[WES.Created, WES.Started],[WES.Started, WES.CancelRequested],[WES.CancelRequested, WES.Canceled],[WES.CancelRequested, WES.CancelFailed],[WES.Started, WES.CompletedStateRequested],[WES.Started, WES.Completed],[WES.Started, WES.CompleteFailed],[WES.Started, WES.TimedOut],[WES.Started, WES.Terminated],[WES.Started, WES.ContinuedAsNew],[WES.Started, WES.ContinueAsNewFailed],[WES.CompletedStateRequested, WES.Completed],[WES.CompletedStateRequested, WES.CompleteFailed],[WES.CompletedStateRequested, WES.TimedOut],[WES.CompletedStateRequested, WES.Terminated],[WES.Started, WES.ExecutionFailedStateRequested],[WES.Started, WES.ExecutionFailed],[WES.ExecutionFailedStateRequested, WES.ExecutionFailed],[WES.Started, WES.FailFailed],]

Const UUID_GENERATOR

UUID_GENERATOR: unique symbol = Symbol('UUID_GENERATOR')

Const WORKFLOWS

WORKFLOWS: unique symbol = Symbol('WORKFLOWS')

Const WORKFLOW_CLIENT

WORKFLOW_CLIENT: unique symbol = Symbol('WORKFLOW_CLIENT')

Const WORKFLOW_CLIENT_TAG

WORKFLOW_CLIENT_TAG: "workflow-client-tag" = "workflow-client-tag"

Const WORKFLOW_LOCAL_CLIENT_FACTORY

WORKFLOW_LOCAL_CLIENT_FACTORY: unique symbol = Symbol('WORKFLOW_LOCAL_CLIENT_FACTORY')

Const WORKFLOW_REMOTE_CLIENT_FACTORY

WORKFLOW_REMOTE_CLIENT_FACTORY: unique symbol = Symbol('WORKFLOW_REMOTE_CLIENT_FACTORY')

Const WORKFLOW_STARTED_AND_COMPLETED_TRANSITION

WORKFLOW_STARTED_AND_COMPLETED_TRANSITION: EventType[] = [EventType.WorkflowExecutionStarted,EventType.ActivityTaskScheduled,EventType.ActivityTaskStarted,EventType.ActivityTaskCompleted,EventType.WorkflowExecutionCompleted,]

Const WORKFLOW_WORKER_FACTORY

WORKFLOW_WORKER_FACTORY: unique symbol = Symbol('WORKFLOW_WORKER_FACTORY')

Const activity

activity: function = decoratorFactory<string>('name')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const activityId

activityId: "12345" = "12345"

Const actorClient

actorClient: function = tagged(ACTOR_CLIENT_TAG, true)

Type declaration

    • (target: any, targetKey: string, index?: number | undefined): void
    • Parameters

      • target: any
      • targetKey: string
      • Optional index: number | undefined

      Returns void

Const applicationFactory

applicationFactory: ConfigurableApplicationFactory = new ConfigurableApplicationFactory(configProvider)

Const arrayConcat

arrayConcat: concat = [].concat

Const childPolicy

childPolicy: function = decoratorFactory<ChildPolicy>('childPolicy')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const config

config: ApplicationConfiguration = new ApplicationConfiguration(swf)

Const configProvider

configProvider: BaseApplicationConfigurationProvider = new BaseApplicationConfigurationProvider(config)

Const configuration

configuration: function = createDecorator<ApplicationConfiguration>('configuration')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultChildPolicy

defaultChildPolicy: function = decoratorFactory<ChildPolicy>('defaultChildPolicy')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultExecutionStartToCloseTimeout

defaultExecutionStartToCloseTimeout: function = decoratorFactory<string>('defaultExecutionStartToCloseTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultLambdaRole

defaultLambdaRole: function = decoratorFactory<string>('defaultLambdaRole')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultSerializer

defaultSerializer: Serializer = JSON

Const defaultTaskHeartbeatTimeout

defaultTaskHeartbeatTimeout: function = decoratorFactory<string>('defaultTaskHeartbeatTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultTaskList

defaultTaskList: function = decoratorFactory<TaskList>('defaultTaskList')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultTaskPriority

defaultTaskPriority: function = decoratorFactory<string>('defaultTaskPriority')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultTaskScheduleToCloseTimeout

defaultTaskScheduleToCloseTimeout: function = decoratorFactory<string>('defaultTaskScheduleToCloseTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultTaskScheduleToStartTimeout

defaultTaskScheduleToStartTimeout: function = decoratorFactory<string>('defaultTaskScheduleToStartTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const defaultTaskStartToCloseTimeout

defaultTaskStartToCloseTimeout: function = decoratorFactory<string>('defaultTaskStartToCloseTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const description

description: function = decoratorFactory<string>('description')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const domain

domain: "expectedDomain" = "expectedDomain"

Const executionStartToCloseTimeout

executionStartToCloseTimeout: function = decoratorFactory<string>('executionStartToCloseTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const expect

expect: ExpectStatic = chai.expect

Const heartbeatTimeout

heartbeatTimeout: function = decoratorFactory<string>('heartbeatTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const lambdaRole

lambdaRole: function = decoratorFactory<string>('lambdaRole')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const name

name: function = decoratorFactory<string>('name')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const scheduleToCloseTimeout

scheduleToCloseTimeout: function = decoratorFactory<string>('scheduleToCloseTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const scheduleToStartTimeout

scheduleToStartTimeout: function = decoratorFactory<string>('scheduleToStartTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const serializer

serializer: function = decoratorFactory<Serializer>('serializer')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const services

services: function = createDecorator<Binding[]>('services')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const startToCloseTimeout

startToCloseTimeout: function = decoratorFactory<string>('startToCloseTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const swf

swf: SWF = new SWF({ region: 'us-east-1' })

Const tagList

tagList: function = decoratorFactory<string[]>('tagList')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const taskList

taskList: "expectedTaskList" = "expectedTaskList"

Const taskPriority

taskPriority: function = decoratorFactory<string>('taskPriority')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const taskStartToCloseTimeout

taskStartToCloseTimeout: function = decoratorFactory<string>('taskStartToCloseTimeout')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const testActivityName

testActivityName: "TestActivityName" = "TestActivityName"

Const testActivityVersion

testActivityVersion: "test-version-123" = "test-version-123"

Const testActorSymbol

testActorSymbol: unique symbol = Symbol('testActorSymbol')

Const testDeciderSymbol

testDeciderSymbol: unique symbol = Symbol('testDeciderSymbol')

Const testTaskList

testTaskList: "test-task-list" = "test-task-list"

Const testWorkflowSymbol

testWorkflowSymbol: unique symbol = Symbol('test wf symbol')

Const version

version: function = decoratorFactory<string>('version')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const workflow

workflow: function = decoratorFactory<string>('name')

Type declaration

    • (value?: T): R
    • Parameters

      • Optional value: T

      Returns R

Const workflowClient

workflowClient: function = tagged(WORKFLOW_CLIENT_TAG, true)

Type declaration

    • (target: any, targetKey: string, index?: number | undefined): void
    • Parameters

      • target: any
      • targetKey: string
      • Optional index: number | undefined

      Returns void

Functions

activityDefinitionDecoratorFactory

Const activityName

  • activityName(): string

boot

  • boot(): Promise<void>

Const caller

classLevelDefinition

createApplication

  • createApplication<T>(newable: Newable<T>): T

createDecisionTask

  • createDecisionTask(eventList: HistoryEvent[]): DecisionTask

createDecorator

  • createDecorator<T>(property: keyof ApplicationDefinition): function
  • Type parameters

    • T

    Parameters

    • property: keyof ApplicationDefinition

    Returns function

      • (value?: T): R
      • Parameters

        • Optional value: T

        Returns R

createNewActivityDecision

  • createNewActivityDecision(activityId?: string): ScheduleActivityTaskDecisionAttributes

definitionCreatorFactory

  • definitionCreatorFactory<D>(definitionContainerClass: Newable<D>): (Anonymous function)

expectActivityState

expectActivityStateMachine

expectHistoryEvent

  • expectHistoryEvent<T>(event: HistoryEvent, expectation: EventExpectation<T>): void

generateDecisionTask

  • generateDecisionTask(nextPageToken: string, events: HistoryEvent[]): DecisionTask

generateHistoryEventList

  • generateHistoryEventList(from: number, to: number): HistoryEvent[]

getClassLevelDefinitionsFromClass

  • getClassLevelDefinitionsFromClass<T>(newable: Newable<any>): T

getParams

  • getParams(event: HistoryEvent): any

getPropertyLevelDefinitionsFromClass

  • getPropertyLevelDefinitionsFromClass<T>(newable: Newable<any>): T[]

merge

  • merge(obj1: any, obj2: any): any

propertyLevelDefinition

Const randomActivityType

  • randomActivityType(): object

Const randomTaskList

  • randomTaskList(): object

Const randomTimestampGen

  • randomTimestampGen(): Date

Const taskListName

  • taskListName(): string

workflowDecoratorFactory

Object literals

Const CANCELLED_PARAMS

CANCELLED_PARAMS: object

details

details: string = "details test"

Const COMPLETED_PARAMS

COMPLETED_PARAMS: object

result

result: string = "result test"

Const FAILED_PARAMS

FAILED_PARAMS: object

details

details: string = "details test"

reason

reason: string = "reason test"

Const REQUEST_CANCELLED_PARAMS

REQUEST_CANCELLED_PARAMS: object

activityId

activityId: string = "test activity id"

Const SCHEDULED_PARAMS

SCHEDULED_PARAMS: object

activityId

activityId: string = "test activity id"

activityType

activityType: string = "test activity type"

control

control: string = "test control"

heartbeatTimeout

heartbeatTimeout: string = "heartbeatTimeout test"

input

input: string = "test input"

scheduleToCloseTimeout

scheduleToCloseTimeout: string = "scheduleToCloseTimeout test"

scheduleToStartTimeout

scheduleToStartTimeout: string = "scheduleToStartTimeout test"

startToCloseTimeout

startToCloseTimeout: string = "startToCloseTimeout test"

taskList

taskList: string = "test task list"

Const STARTED_PARAMS

STARTED_PARAMS: object

identity

identity: string = "identity test"

Const TIMEOUT_PARAMS

TIMEOUT_PARAMS: object

details

details: string = "test details"

timeoutType

timeoutType: string = "test timeout type"

Const activityType

activityType: object

name

name: string = "type"

version

version: string = "1.0"

Const binding

binding: object

impl

impl: TestWfImpl = TestWfImpl

key

key: symbol = TEST_WF

Const mockActor

mockActor: object

d

d: string = "mock actor"

Const scheduleParams

scheduleParams: object

activityId

activityId: string

activityType

activityType: object

Type declaration

  • name: string
  • version: string

Generated using TypeDoc