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 Summary)

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

Constructors

constructor

new ActorDereferenceParse<
    S,
    K extends IParseMetadata = IParseMetadata,
    M extends IParseMetadata = IParseMetadata,
>(
    args: IActorDereferenceParseArgs<S, K, M>,
): 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:59

Properties

`Readonly`beforeActors

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

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

`Readonly`bus

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

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

`Protected`dereferenceErrorHandler

dereferenceErrorHandler<N, M extends Readable>(
    action: IActionDereferenceParse<K>,
    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: 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:52

`Protected`getDefaultLogData

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

`Abstract`getMetadata

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

`Protected`handleDereferenceStreamErrors

handleDereferenceStreamErrors<L extends IParseMetadata, T extends Readable>(
action: IActionDereferenceParse<L>,
data: T,
): 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:73

`Protected`logDebug

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

run

run(
action: IActionDereferenceParse<K>,
): 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:91

runObservable

runObservable(
action: IActionDereferenceParse<K>,
sideData: undefined,
): 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.
- sideData: undefined
Returns Promise<IActorDereferenceParseOutput<S, M>>
A promise that resolves to the run result.
Inherited from ActorDereferenceBase.runObservable
- Defined in core/lib/Actor.ts:87

test

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

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

Class ActorDereferenceParse<S, K, M>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ActorDereferenceParse<S, K, M>

Properties

ReadonlybeforeActors

Readonlybus

ReadonlymediaMappings

ReadonlymediatorDereference

ReadonlymediatorParse

ReadonlymediatorParseMediatypes

Readonlyname

Default

Methods

ProtecteddereferenceErrorHandler

Type Parameters

Parameters

Returns Promise<N & { data: M }>

ProtectedgetDefaultLogData

Parameters

Returns any

AbstractgetMetadata

Parameters

Returns Promise<undefined | K>

ProtectedhandleDereferenceStreamErrors

Type Parameters

Parameters

Returns T

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<IActorDereferenceParseOutput<S, M>>

runObservable

Parameters

Returns Promise<IActorDereferenceParseOutput<S, M>>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

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

`Readonly`beforeActors

`Readonly`bus

`Readonly`mediaMappings

`Readonly`mediatorDereference

`Readonly`mediatorParse

`Readonly`mediatorParseMediatypes

`Readonly`name

`Protected`dereferenceErrorHandler

`Protected`getDefaultLogData

`Abstract`getMetadata

`Protected`handleDereferenceStreamErrors

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger