Class ActorDereferenceBase<I, T, O, TS>Abstract

A base actor for dereferencing URLs to (generic) streams.

Actor types:

  • Input: IActionDereference: A URL.
  • Test:
  • Output: IActorDereferenceOutput: A Readable stream

See

  • IActionDereference
  • IActorDereferenceOutput

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

beforeActors bus name

Methods

dereferenceErrorHandler getDefaultLogData logDebug logError logFatal logInfo logTrace logWarn run runObservable test getContextLogger

Constructors

constructor

Properties

ReadonlybeforeActors

beforeActors: Actor<I, T, O, TS>[] = []

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

Readonlybus

bus: Bus<Actor<I, T, O, TS>, I, T, O, TS>

The bus this actor subscribes to.

Readonlyname

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

ProtecteddereferenceErrorHandler

  • dereferenceErrorHandler<N, M extends Readable>(
        action: I,
        error: unknown,
        output: N,
    ): Promise<N & { data: M }>

  • Handle the given error as a rejection or delegate it to the logger, depending on whether or not hard errors are enabled.

    Type Parameters

    • N
    • M extends Readable

    Parameters

    • action: I

      An action.

    • error: unknown

      An error that has occurred.

    • output: N

      Data to add to the output

    Returns Promise<N & { data: M }>

ProtectedgetDefaultLogData

ProtectedlogDebug

ProtectedlogError

ProtectedlogFatal

ProtectedlogInfo

ProtectedlogTrace

ProtectedlogWarn

Abstractrun

  • run(action: I, sideData: TS): Promise<O>

  • Run the given action on this actor.

    In most cases, this method should not be called directly. Instead, #runObservable should be called.

    Parameters

    • action: I

      The action to run.

    • sideData: TS

    Returns Promise<O>

    A promise that resolves to the run result.

runObservable

  • runObservable(action: I, sideData: TS): Promise<O>

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

    Parameters

    • action: I

      The action to run.

    • sideData: TS

    Returns Promise<O>

    A promise that resolves to the run result.

Abstracttest

  • test(action: I): Promise<TestResult<T, TS>>

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

    Parameters

    • action: I

      The action to test.

    Returns Promise<TestResult<T, TS>>

    A promise that resolves to the test result.

StaticgetContextLogger

Settings

Member Visibility

On This Page

Constructors
Properties
Methods