Class ActorDereferenceBase<I, T, O>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 full)

Constructors

constructor

Properties

beforeActors bus name

Methods

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

Constructors

constructor

Properties

Readonly beforeActors

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

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

Readonly bus

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

The bus this actor subscribes to.

Readonly name

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

deinitialize

  • deinitialize(): Promise<any>

  • Deinitialize this actor. This should be used for cleaning up things when the application is shut down, such as closing files and removing temporary files.

    Returns Promise<any>

    A promise that resolves when the actor has been deinitialized.

Protected dereferenceErrorHandler

  • dereferenceErrorHandler<N, M>(action, error, output): 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;
    }>

Protected getDefaultLogData

initialize

  • initialize(): Promise<any>

  • Initialize this actor. This should be used for doing things that take a while, such as opening files.

    Returns Promise<any>

    A promise that resolves when the actor has been initialized.

Protected logDebug

Protected logError

Protected logFatal

Protected logInfo

Protected logTrace

Protected logWarn

Abstract run

  • run(action): 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.

    Returns Promise<O>

    A promise that resolves to the run result.

runObservable

  • runObservable(action): Promise<O>

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

    Parameters

    • action: I

      The action to run.

    Returns Promise<O>

    A promise that resolves to the run result.

Abstract test

  • test(action): Promise<T>

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

    Parameters

    • action: I

      The action to test.

    Returns Promise<T>

    A promise that resolves to the test result.

Static getContextLogger

Settings

Member Visibility

Theme

On This Page

constructorbeforeActorsbusnamedeinitializedereferenceErrorHandlergetDefaultLogDatainitializelogDebuglogErrorlogFatallogInfologTracelogWarnrunrunObservabletestgetContextLogger