Class ActorFunctionFactoryTermRegex

A comunica TermFunctionRegex Function Factory Actor.

Hierarchy (View Summary)

ActorFunctionFactoryDedicated
- ActorFunctionFactoryTermRegex

Index

Constructors

constructor

new ActorFunctionFactoryTermRegex(
args: IActorFunctionFactoryArgs,
): ActorFunctionFactoryTermRegex
Parameters
- args: IActorFunctionFactoryArgs
Returns ActorFunctionFactoryTermRegex
Overrides ActorFunctionFactoryDedicated.constructor
- Defined in actor-function-factory-term-regex/lib/ActorFunctionFactoryTermRegex.ts:18

Properties

`Readonly`beforeActors

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

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionFunctionFactory,
        IActorTest,
        IActorFunctionFactoryOutput,
        undefined,
    >,
    IActionFunctionFactory,
    IActorTest,
    IActorFunctionFactoryOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`functionNames

functionNames: StringArray

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`termFunction

termFunction: boolean

Methods

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorFunctionFactoryDedicated.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 ActorFunctionFactoryDedicated.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 ActorFunctionFactoryDedicated.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 ActorFunctionFactoryDedicated.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 ActorFunctionFactoryDedicated.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 ActorFunctionFactoryDedicated.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 ActorFunctionFactoryDedicated.logWarn
- Defined in core/lib/Actor.ts:122

run

run<T extends IActionFunctionFactory>(
    _: 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
- _: T
  The action to run.
Returns Promise<
    T extends { requireTermExpression: true }
        ? IActorFunctionFactoryOutputTerm
        : IActorFunctionFactoryOutput,
>
A promise that resolves to the run result.
Overrides ActorFunctionFactoryDedicated.run
- Defined in actor-function-factory-term-regex/lib/ActorFunctionFactoryTermRegex.ts:26

runObservable

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

test

test(action: IActionFunctionFactory): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionFunctionFactory
  The action to test.
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Inherited from ActorFunctionFactoryDedicated.test
- Defined in bus-function-factory/lib/ActorFunctionFactoryDedicated.ts:19

`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 ActorFunctionFactoryDedicated.getContextLogger
- Defined in core/lib/Actor.ts:56

Class ActorFunctionFactoryTermRegex

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorFunctionFactoryTermRegex

Properties

ReadonlybeforeActors

Readonlybus

ReadonlyfunctionNames

Readonlyname

Default

ReadonlytermFunction

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

run

Type Parameters

Parameters

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

runObservable

Parameters

Returns Promise<IActorFunctionFactoryOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`functionNames

`Readonly`name

`Readonly`termFunction

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

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

`Static`getContextLogger