Class ActorQueryOperationTyped<O, TS>`Abstract`

A base implementation for query operation actors for a specific operation type.

Type Parameters

O extends Algebra.Operation
TS = undefined

Hierarchy (View Summary)

ActorQueryOperation<TS>
- ActorQueryOperationTyped
  - ActorQueryOperationTypedMediated
  - ActorQueryOperationValues

Index

Constructors

`Protected`constructor

new ActorQueryOperationTyped<O extends Operation, TS = undefined>(
args: IActorQueryOperationArgs<TS>,
operationName: string,
): ActorQueryOperationTyped<O, TS>
Type Parameters
- O extends Operation
- TS = undefined
Parameters
- args: IActorQueryOperationArgs<TS>
- operationName: string
Returns ActorQueryOperationTyped<O, TS>
Overrides ActorQueryOperation.constructor
- Defined in bus-query-operation/lib/ActorQueryOperationTyped.ts:25

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionQueryOperation,
    IActorTest,
    IQueryOperationResult,
    TS,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<IActionQueryOperation, IActorTest, IQueryOperationResult, TS>,
    IActionQueryOperation,
    IActorTest,
    IQueryOperationResult,
    TS,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`operationName

operationName: string

Methods

`Protected`getDefaultLogData

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

run

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

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionQueryOperation
  The action to run.
- sideData: TS
Returns Promise<IQueryOperationResult>
A promise that resolves to the run result.
Overrides ActorQueryOperation.run
- Defined in bus-query-operation/lib/ActorQueryOperationTyped.ts:44

runObservable

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

`Protected` `Abstract`runOperation

runOperation(
    operation: O,
    context: IActionContext,
    sideData: TS,
): Promise<IQueryOperationResult>
Parameters
- operation: O
- context: IActionContext
- sideData: TS
Returns Promise<IQueryOperationResult>
- Defined in bus-query-operation/lib/ActorQueryOperationTyped.ts:72

test

test(action: IActionQueryOperation): Promise<TestResult<IActorTest, TS>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionQueryOperation
  The action to test.
Returns Promise<TestResult<IActorTest, TS>>
A promise that resolves to the test result.
Overrides ActorQueryOperation.test
- Defined in bus-query-operation/lib/ActorQueryOperationTyped.ts:32

`Protected` `Abstract`testOperation

testOperation(
operation: O,
context: IActionContext,
): Promise<TestResult<IActorTest, TS>>
Parameters
- operation: O
- context: IActionContext
Returns Promise<TestResult<IActorTest, TS>>
- Defined in bus-query-operation/lib/ActorQueryOperationTyped.ts:70

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

Class ActorQueryOperationTyped<O, TS>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns ActorQueryOperationTyped<O, TS>

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

ReadonlyoperationName

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<IQueryOperationResult>

runObservable

Parameters

Returns Promise<IQueryOperationResult>

Protected AbstractrunOperation

Parameters

Returns Promise<IQueryOperationResult>

test

Parameters

Returns Promise<TestResult<IActorTest, TS>>

Protected AbstracttestOperation

Parameters

Returns Promise<TestResult<IActorTest, TS>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

Class ActorQueryOperationTyped<O, TS>`Abstract`

`Protected`constructor

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Readonly`operationName

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Protected` `Abstract`runOperation

`Protected` `Abstract`testOperation

`Static`getContextLogger