Class ActorDereferenceParse<S, K, M>`Abstract`

An abstract actor that handles dereference and parse actions.

Actor types: Input: IActionDereferenceParse: A URL. Test: Output: IActorDereferenceParseOutput: A data stream of type output by the Parser.

Type Parameters

S
K extends IParseMetadata = IParseMetadata
M extends IParseMetadata = IParseMetadata

Hierarchy (view full)

ActorDereferenceBase<IActionDereferenceParse<K>, IActorTest, IActorDereferenceParseOutput<S, M>>
- ActorDereferenceParse

Constructors

constructor

new ActorDereferenceParse<S, K, M>(args): ActorDereferenceParse<S, K, M>
Type Parameters
- S
- K extends IParseMetadata = IParseMetadata
- M extends IParseMetadata = IParseMetadata
Parameters
- args: IActorDereferenceParseArgs<S, K, M>
Returns ActorDereferenceParse<S, K, M>
Overrides ActorDereferenceBase.constructor
- Defined in bus-dereference/lib/ActorDereferenceParse.ts:58

Properties

`Readonly` beforeActors

beforeActors: Actor<IActionDereferenceParse<K>, IActorTest, IActorDereferenceParseOutput<S, M>>[] = []

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

`Readonly` bus

bus: Bus<Actor<IActionDereferenceParse<K>, IActorTest, IActorDereferenceParseOutput<S, M>>, IActionDereferenceParse<K>, IActorTest, IActorDereferenceParseOutput<S, M>>

The bus this actor subscribes to.

`Readonly` mediaMappings

mediaMappings: Record<string, string>

`Readonly` mediatorDereference

mediatorDereference: MediatorDereference

`Readonly` mediatorParse

mediatorParse: MediateMediaTyped<IActionParse<K>, IActorTest, IActorParseOutput<S, M>>

`Readonly` mediatorParseMediatypes

mediatorParseMediatypes: MediateMediaTypes

`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.
Inherited from ActorDereferenceBase.deinitialize
- Defined in core/lib/Actor.ts:106

`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: IActionDereferenceParse<K>
  An action.
- error: unknown
  An error that has occurred.
- output: N
  Data to add to the output
Returns Promise<N & {
data: M;
}>
Inherited from ActorDereferenceBase.dereferenceErrorHandler
- Defined in bus-dereference/lib/ActorDereferenceBase.ts:47

`Protected` getDefaultLogData

getDefaultLogData(context, data?): any
Parameters
- context: IActionContext
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns any
Inherited from ActorDereferenceBase.getDefaultLogData
- Defined in core/lib/Actor.ts:112

`Abstract` getMetadata

getMetadata(dereference): Promise<undefined | K>
Parameters
- dereference: IActorDereferenceOutput
Returns Promise<undefined | K>
- Defined in bus-dereference/lib/ActorDereferenceParse.ts:88

`Protected` handleDereferenceStreamErrors

handleDereferenceStreamErrors<L, T>(action, data): T
If hard errors are disabled, modify the given stream so that errors are delegated to the logger.
Type Parameters
- L extends IParseMetadata
- T extends Readable
Parameters
- action: IActionDereferenceParse<L>
  A dereference action.
- data: T
  A data stream.
Returns T
The resulting data stream.
- Defined in bus-dereference/lib/ActorDereferenceParse.ts:72

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.
Inherited from ActorDereferenceBase.initialize
- Defined in core/lib/Actor.ts:95

`Protected` logDebug

logDebug(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from ActorDereferenceBase.logDebug
- Defined in core/lib/Actor.ts:125

`Protected` logError

logError(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from ActorDereferenceBase.logError
- Defined in core/lib/Actor.ts:146

`Protected` logFatal

logFatal(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from ActorDereferenceBase.logFatal
- Defined in core/lib/Actor.ts:153

`Protected` logInfo

logInfo(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from ActorDereferenceBase.logInfo
- Defined in core/lib/Actor.ts:132

`Protected` logTrace

logTrace(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from ActorDereferenceBase.logTrace
- Defined in core/lib/Actor.ts:118

`Protected` logWarn

logWarn(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from ActorDereferenceBase.logWarn
- Defined in core/lib/Actor.ts:139

run

run(action): Promise<IActorDereferenceParseOutput<S, M>>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionDereferenceParse<K>
  The action to run.
Returns Promise<IActorDereferenceParseOutput<S, M>>
A promise that resolves to the run result.
Overrides ActorDereferenceBase.run
- Defined in bus-dereference/lib/ActorDereferenceParse.ts:90

runObservable

runObservable(action): Promise<IActorDereferenceParseOutput<S, M>>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionDereferenceParse<K>
  The action to run.
Returns Promise<IActorDereferenceParseOutput<S, M>>
A promise that resolves to the run result.
Inherited from ActorDereferenceBase.runObservable
- Defined in core/lib/Actor.ts:82

test

test(_action): Promise<IActorTest>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionDereference
  The action to test.
Returns Promise<IActorTest>
A promise that resolves to the test result.
Overrides ActorDereferenceBase.test
- Defined in bus-dereference/lib/ActorDereferenceParse.ts:62

`Static` getContextLogger

getContextLogger(context): undefined | Logger
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns undefined | Logger
The logger or undefined.
Inherited from ActorDereferenceBase.getContextLogger
- Defined in core/lib/Actor.ts:51

Class ActorDereferenceParse<S, K, M>Abstract

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ActorDereferenceParse<S, K, M>

Properties

Readonly beforeActors

Readonly bus

Readonly mediaMappings

Readonly mediatorDereference

Readonly mediatorParse

Readonly mediatorParseMediatypes

Readonly name

Default

Methods

deinitialize

Returns Promise<any>

Protected dereferenceErrorHandler

Type Parameters

Parameters

Returns Promise<N & { data: M; }>

Protected getDefaultLogData

Parameters

Returns any

Returns any

Abstract getMetadata

Parameters

Returns Promise<undefined | K>

Protected handleDereferenceStreamErrors

Type Parameters

Parameters

Returns T

initialize

Returns Promise<any>

Protected logDebug

Parameters

Returns any

Returns void

Protected logError

Parameters

Returns any

Returns void

Protected logFatal

Parameters

Returns any

Returns void

Protected logInfo

Parameters

Returns any

Returns void

Protected logTrace

Parameters

Returns any

Returns void

Protected logWarn

Parameters

Returns any

Returns void

run

Parameters

Returns Promise<IActorDereferenceParseOutput<S, M>>

runObservable

Parameters

Returns Promise<IActorDereferenceParseOutput<S, M>>

test

Parameters

Returns Promise<IActorTest>

Static getContextLogger

Parameters

Returns undefined | Logger

Settings

Member Visibility

Theme

Class ActorDereferenceParse<S, K, M>`Abstract`

`Readonly` beforeActors

`Readonly` bus

`Readonly` mediaMappings

`Readonly` mediatorDereference

`Readonly` mediatorParse

`Readonly` mediatorParseMediatypes

`Readonly` name

`Protected` dereferenceErrorHandler

Returns Promise<N & {
data: M;
}>

`Protected` getDefaultLogData

`Abstract` getMetadata

`Protected` handleDereferenceStreamErrors

`Protected` logDebug

`Protected` logError

`Protected` logFatal

`Protected` logInfo

`Protected` logTrace

`Protected` logWarn

`Static` getContextLogger