Class ActorQueryOperationOrderBy

An incremunica OrderBy Query Operation Actor.

Hierarchy

  • ActorQueryOperationTypedMediated<Algebra.OrderBy>
    • ActorQueryOperationOrderBy

Constructors

constructor

Properties

beforeActors bus mediatorQueryOperation name operationName

Methods

getDefaultLogData logDebug logError logFatal logInfo logTrace logWarn run runObservable runOperation test testOperation getContextLogger

Constructors

constructor

Properties

ReadonlybeforeActors

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

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

Readonlybus

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

The bus this actor subscribes to.

ReadonlymediatorQueryOperation

mediatorQueryOperation: MediatorQueryOperation

Readonlyname

name: string

The name for this actor.

Default

{<rdf:subject>}

ReadonlyoperationName

operationName: string

Methods

ProtectedgetDefaultLogData

  • getDefaultLogData(context: IActionContext, data?: () => any): any

  • Parameters

    • context: IActionContext
    • Optionaldata: () => any

    Returns any

ProtectedlogDebug

  • logDebug(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogError

  • logError(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogFatal

  • logFatal(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogInfo

  • logInfo(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogTrace

  • logTrace(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogWarn

  • logWarn(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

run

  • run(
        action: IActionQueryOperation,
        sideData: undefined,
    ): 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: undefined

    Returns Promise<IQueryOperationResult>

    A promise that resolves to the run result.

runObservable

  • runObservable(
        action: IActionQueryOperation,
        sideData: undefined,
    ): Promise<IQueryOperationResult>

  • Run the given action on this actor AND invokes the Bus#onRun method.

    Parameters

    • action: IActionQueryOperation

      The action to run.

    • sideData: undefined

    Returns Promise<IQueryOperationResult>

    A promise that resolves to the run result.

runOperation

test

  • test(action: IActionQueryOperation): Promise<TestResult<IActorTest, undefined>>

  • Check if this actor can run the given action, without actually running it.

    Parameters

    • action: IActionQueryOperation

      The action to test.

    Returns Promise<TestResult<IActorTest, undefined>>

    A promise that resolves to the test result.

testOperation

StaticgetContextLogger

  • 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.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods