Class ActorContextPreprocessConvertShortcuts

A comunica Convert Shortcuts Context Preprocess Actor.

Hierarchy (View Summary)

ActorContextPreprocess
- ActorContextPreprocessConvertShortcuts

Index

Constructors

constructor

new ActorContextPreprocessConvertShortcuts(
args: IActorContextPreprocessConvertShortcutsArgs,
): ActorContextPreprocessConvertShortcuts
Parameters
- args: IActorContextPreprocessConvertShortcutsArgs
Returns ActorContextPreprocessConvertShortcuts
Overrides ActorContextPreprocess.constructor
- Defined in actor-context-preprocess-convert-shortcuts/lib/ActorContextPreprocessConvertShortcuts.ts:13

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionContextPreprocess,
    IActorTest,
    IActorContextPreprocessOutput,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionContextPreprocess,
        IActorTest,
        IActorContextPreprocessOutput,
        undefined,
    >,
    IActionContextPreprocess,
    IActorTest,
    IActorContextPreprocessOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`contextKeyShortcuts

contextKeyShortcuts: Record<string, string>

`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 ActorContextPreprocess.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 ActorContextPreprocess.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 ActorContextPreprocess.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 ActorContextPreprocess.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 ActorContextPreprocess.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 ActorContextPreprocess.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 ActorContextPreprocess.logWarn
- Defined in core/lib/Actor.ts:122

run

run(action: IAction): Promise<IActorContextPreprocessOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IAction
  The action to run.
Returns Promise<IActorContextPreprocessOutput>
A promise that resolves to the run result.
Overrides ActorContextPreprocess.run
- Defined in actor-context-preprocess-convert-shortcuts/lib/ActorContextPreprocessConvertShortcuts.ts:21

runObservable

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

test

test(_action: IAction): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IAction
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorContextPreprocess.test
- Defined in actor-context-preprocess-convert-shortcuts/lib/ActorContextPreprocessConvertShortcuts.ts:17

`Static`expandShortcuts

expandShortcuts(
context: IActionContext,
contextKeyShortcuts: Record<string, string>,
): IActionContext
Parameters
- context: IActionContext
- contextKeyShortcuts: Record<string, string>
Returns IActionContext
- Defined in actor-context-preprocess-convert-shortcuts/lib/ActorContextPreprocessConvertShortcuts.ts:27

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

Class ActorContextPreprocessConvertShortcuts

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorContextPreprocessConvertShortcuts

Properties

ReadonlybeforeActors

Readonlybus

ReadonlycontextKeyShortcuts

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

run

Parameters

Returns Promise<IActorContextPreprocessOutput>

runObservable

Parameters

Returns Promise<IActorContextPreprocessOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticexpandShortcuts

Parameters

Returns IActionContext

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`contextKeyShortcuts

`Readonly`name

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`expandShortcuts

`Static`getContextLogger