Class ActorFunctionFactory<TS>`Abstract`

A comunica actor for function factory events.

Actor types:

Input: IActionFunctions: A request to receive a function implementation for a given function name and potentially the function arguments.
Test:
Output: IActorFunctionsOutput: A function implementation.

See

IActionFunctionFactory
IActorFunctionFactoryOutput

Type Parameters

TS = undefined

Hierarchy (View Summary)

Actor<IActionFunctionFactory, IActorTest, IActorFunctionFactoryOutput, TS>
- ActorFunctionFactory
  - ActorFunctionFactoryDedicated
  - ActorFunctionFactoryExpressionExtensions

Index

Constructors

constructor

new ActorFunctionFactory<TS = undefined>(
args: IActorFunctionFactoryArgs<TS>,
): ActorFunctionFactory<TS>
Type Parameters
- TS = undefined
Parameters
- args: IActorFunctionFactoryArgs<TS>
  \
Returns ActorFunctionFactory<TS>
Default Nested
bus \

Default Nested
busFailMessage
Overrides Actor.constructor
- Defined in bus-function-factory/lib/ActorFunctionFactory.ts:27

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionFunctionFactory,
    IActorTest,
    IActorFunctionFactoryOutput,
    TS,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionFunctionFactory,
        IActorTest,
        IActorFunctionFactoryOutput,
        TS,
    >,
    IActionFunctionFactory,
    IActorTest,
    IActorFunctionFactoryOutput,
    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
Inherited from Actor.getDefaultLogData
- Defined in core/lib/Actor.ts:95

`Protected`logDebug

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

`Protected`logError

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

`Protected`logFatal

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

`Protected`logInfo

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

`Protected`logTrace

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

`Protected`logWarn

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

`Abstract`run

run<T extends IActionFunctionFactory>(
    action: T,
): Promise<
    T extends { requireTermExpression: true }
        ? IActorFunctionFactoryOutputTerm
        : IActorFunctionFactoryOutput,
>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Type Parameters
- T extends IActionFunctionFactory
Parameters
- action: T
  The action to run.
Returns Promise<
    T extends { requireTermExpression: true }
        ? IActorFunctionFactoryOutputTerm
        : IActorFunctionFactoryOutput,
>
A promise that resolves to the run result.
Overrides Actor.run
- Defined in bus-function-factory/lib/ActorFunctionFactory.ts:31

runObservable

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

`Abstract`test

test(action: IActionFunctionFactory): Promise<TestResult<IActorTest, TS>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionFunctionFactory
  The action to test.
Returns Promise<TestResult<IActorTest, TS>>
A promise that resolves to the test result.
Inherited from Actor.test
- Defined in core/lib/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.
Inherited from Actor.getContextLogger
- Defined in core/lib/Actor.ts:56

Class ActorFunctionFactory<TS>Abstract

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ActorFunctionFactory<TS>

Default Nested

Default Nested

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

Type Parameters

Parameters

Returns Promise< T extends { requireTermExpression: true } ? IActorFunctionFactoryOutputTerm : IActorFunctionFactoryOutput,>

runObservable

Parameters

Returns Promise<IActorFunctionFactoryOutput>

Abstracttest

Parameters

Returns Promise<TestResult<IActorTest, TS>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

Class ActorFunctionFactory<TS>`Abstract`

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Abstract`run

Returns Promise<
T extends { requireTermExpression: true }
? IActorFunctionFactoryOutputTerm
: IActorFunctionFactoryOutput,
>

`Abstract`test

`Static`getContextLogger