Class Actor<I, T, O, TS>`Abstract`

An actor can act on messages of certain types and provide output of a certain type.

The flow of an actor is as follows:

Send a message to Actor#test to test if an actor can run that action.
If the actor can reply to the message, let the actor run the action using Actor#run.

An actor is typically subscribed to a bus, using which the applicability to an action can be tested.

See

Bus

Type Parameters

I extends IAction
The input type of an actor.
T extends IActorTest
The test type of an actor.
O extends IActorOutput
The output type of an actor.
TS = undefined
The test side data type.

Implements

IActorArgs<I, T, O, TS>

Index

Constructors

`Protected`constructor

new Actor<
    I extends IAction,
    T extends IActorTest,
    O extends IActorOutput,
    TS = undefined,
>(
    args: IActorArgs<I, T, O, TS>,
): Actor<I, T, O, TS>
All enumerable properties from the args object are inherited to this actor.

The actor will subscribe to the given bus when this constructor is called.
Type Parameters
- I extends IAction
- T extends IActorTest
- O extends IActorOutput
- TS = undefined
Parameters
- args: IActorArgs<I, T, O, TS>
  Arguments object
  - OptionalbeforeActors?: Actor<I, T, O, TS>[]
    Actor that must be registered in the bus before this actor.
  - bus: Bus<Actor<I, T, O, TS>, I, T, O, TS>
    The bus this actor subscribes to.
  - OptionalbusFailMessage?: string
    The message that will be configured in the bus for reporting failures.
    
    This message may be a template string that contains references to the executed action. For example, the following templated string is allowed: "RDF dereferencing failed: no actors could handle ${action.handle.mediaType}"
  - name: string
    The name for this actor.
    
    Default
    {<rdf:subject>}
Returns Actor<I, T, O, TS>
Throws
When required arguments are missing.
- Defined in Actor.ts:40

Properties

`Readonly`beforeActors

beforeActors: Actor<I, T, O, TS>[] = []

Actor that must be registered in the bus before this actor.

`Readonly`bus

bus: Bus<Actor<I, T, O, TS>, I, T, O, TS>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
- Defined in Actor.ts:95

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
- Defined in Actor.ts:108

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
- Defined in Actor.ts:129

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
- Defined in Actor.ts:136

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
- Defined in Actor.ts:115

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
- Defined in Actor.ts:101

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
- Defined in Actor.ts:122

`Abstract`run

run(action: I, sideData: TS): Promise<O>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: I
  The action to run.
- sideData: TS
Returns Promise<O>
A promise that resolves to the run result.
- Defined in Actor.ts:78

runObservable

runObservable(action: I, sideData: TS): Promise<O>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: I
  The action to run.
- sideData: TS
Returns Promise<O>
A promise that resolves to the run result.
- Defined in Actor.ts:87

`Abstract`test

test(action: I): Promise<TestResult<T, TS>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: I
  The action to test.
Returns Promise<TestResult<T, TS>>
A promise that resolves to the test result.
- Defined in Actor.ts:67

`Static`getContextLogger

getContextLogger(context: IActionContext): undefined | Logger
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns undefined | Logger
The logger or undefined.
- Defined in Actor.ts:56

Class Actor<I, T, O, TS>Abstract

See

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

OptionalbeforeActors?: Actor<I, T, O, TS>[]

bus: Bus<Actor<I, T, O, TS>, I, T, O, TS>

OptionalbusFailMessage?: string

name: string

Default

Returns Actor<I, T, O, TS>

Throws

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Methods

ProtectedgetDefaultLogData

Parameters

Returns any

ProtectedlogDebug

Parameters

Returns void

ProtectedlogError

Parameters

Returns void

ProtectedlogFatal

Parameters

Returns void

ProtectedlogInfo

Parameters

Returns void

ProtectedlogTrace

Parameters

Returns void

ProtectedlogWarn

Parameters

Returns void

Abstractrun

Parameters

Returns Promise<O>

runObservable

Parameters

Returns Promise<O>

Abstracttest

Parameters

Returns Promise<TestResult<T, TS>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

Class Actor<I, T, O, TS>`Abstract`

`Protected`constructor

`Optional`beforeActors?: Actor<I, T, O, TS>[]

`Optional`busFailMessage?: string

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Abstract`run

`Abstract`test

`Static`getContextLogger