Class ActorDereferenceRdf`Abstract`

A base actor for dereferencing URLs to quad streams.

Actor types:

Input: IActionDereferenceRdf: A URL.
Test:
Output: IActorDereferenceRdfOutput: A quad stream.

See

IActionDereferenceRdf
IActorDereferenceRdfOutput

Hierarchy (View Summary)

ActorDereferenceParse<
    RDF.Stream,
    IActionRdfParseMetadata,
    IActorRdfParseOutputMetadata,
>
- ActorDereferenceRdf
  - ActorDereferenceRdfParse

Constructors

constructor

new ActorDereferenceRdf(args: IActorDereferenceRdfArgs): ActorDereferenceRdf
Parameters
- args: IActorDereferenceRdfArgs
  \
Returns ActorDereferenceRdf
Default Nested
bus \

Default Nested
busFailMessage
Overrides ActorDereferenceParse.constructor
- Defined in bus-dereference-rdf/lib/ActorDereferenceRdf.ts:33

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionDereferenceParse<IActionRdfParseMetadata>,
    IActorTest,
    IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionDereferenceParse<IActionRdfParseMetadata>,
        IActorTest,
        IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
        undefined,
    >,
    IActionDereferenceParse<IActionRdfParseMetadata>,
    IActorTest,
    IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
    undefined,
>

The bus this actor subscribes to.

`Readonly`mediaMappings

mediaMappings: Record<string, string>

`Readonly`mediatorDereference

mediatorDereference: MediatorDereference

`Readonly`mediatorParse

mediatorParse: MediateMediaTyped<
    IActionParse<IActionRdfParseMetadata>,
    IActorTest,
    IActorParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
>

`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<IActionRdfParseMetadata>,
    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<IActionRdfParseMetadata>
  An action.
- error: unknown
  An error that has occurred.
- output: N
  Data to add to the output
Returns Promise<N & { data: M }>
Inherited from ActorDereferenceParse.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 ActorDereferenceParse.getDefaultLogData
- Defined in core/lib/Actor.ts:95

`Abstract`getMetadata

getMetadata(
dereference: IActorDereferenceOutput,
): Promise<undefined | IActionRdfParseMetadata>
Parameters
- dereference: IActorDereferenceOutput
Returns Promise<undefined | IActionRdfParseMetadata>
Inherited from ActorDereferenceParse.getMetadata
- 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.
Inherited from ActorDereferenceParse.handleDereferenceStreamErrors
- 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 ActorDereferenceParse.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 ActorDereferenceParse.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 ActorDereferenceParse.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 ActorDereferenceParse.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 ActorDereferenceParse.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 ActorDereferenceParse.logWarn
- Defined in core/lib/Actor.ts:122

run

run(
action: IActionDereferenceParse<IActionRdfParseMetadata>,
): Promise<
IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
>
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<IActionRdfParseMetadata>
  The action to run.
Returns Promise<
IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
>
A promise that resolves to the run result.
Inherited from ActorDereferenceParse.run
- Defined in bus-dereference/lib/ActorDereferenceParse.ts:91

runObservable

runObservable(
    action: IActionDereferenceParse<IActionRdfParseMetadata>,
    sideData: undefined,
): Promise<
    IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionDereferenceParse<IActionRdfParseMetadata>
  The action to run.
- sideData: undefined
Returns Promise<
IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
>
A promise that resolves to the run result.
Inherited from ActorDereferenceParse.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.
Inherited from ActorDereferenceParse.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 ActorDereferenceParse.getContextLogger
- Defined in core/lib/Actor.ts:56

Class ActorDereferenceRdfAbstract

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorDereferenceRdf

Default Nested

Default Nested

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 | IActionRdfParseMetadata>

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<Stream<Quad>, IActorRdfParseOutputMetadata>,>

runObservable

Parameters

Returns Promise< IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

Class ActorDereferenceRdf`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

Returns Promise<
IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
>

Returns Promise<
IActorDereferenceParseOutput<Stream<Quad>, IActorRdfParseOutputMetadata>,
>

`Static`getContextLogger