Class ActorRdfUpdateQuadsHypermedia

A comunica Hypermedia RDF Update Quads Actor.

Hierarchy (View Summary)

ActorRdfUpdateQuadsDestination
- ActorRdfUpdateQuadsHypermedia

Constructors

constructor

new ActorRdfUpdateQuadsHypermedia(
args: IActorRdfUpdateQuadsHypermediaArgs,
): ActorRdfUpdateQuadsHypermedia
Parameters
- args: IActorRdfUpdateQuadsHypermediaArgs
Returns ActorRdfUpdateQuadsHypermedia
Overrides ActorRdfUpdateQuadsDestination.constructor
- Defined in actor-rdf-update-quads-hypermedia/lib/ActorRdfUpdateQuadsHypermedia.ts:34

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionRdfUpdateQuads,
    IActorTest,
    IActorRdfUpdateQuadsOutput,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionRdfUpdateQuads,
        IActorTest,
        IActorRdfUpdateQuadsOutput,
        undefined,
    >,
    IActionRdfUpdateQuads,
    IActorTest,
    IActorRdfUpdateQuadsOutput,
    undefined,
>

The bus this actor subscribes to.

`Optional` `Readonly`cache

cache?: LRUCache<
    string,
    Promise<
        {
            cachePolicy: ICachePolicy<IActionDereference>
            | undefined;
            destination: IQuadDestination;
        },
    >,
    unknown,
>

`Readonly`cacheSize

cacheSize: number

`Readonly`httpInvalidator

httpInvalidator: ActorHttpInvalidateListenable

`Readonly`mediatorDereferenceRdf

mediatorDereferenceRdf: MediatorDereferenceRdf

`Readonly`mediatorMetadata

mediatorMetadata: MediatorRdfMetadata

`Readonly`mediatorMetadataExtract

mediatorMetadataExtract: MediatorRdfMetadataExtract

`Readonly`mediatorRdfUpdateHypermedia

mediatorRdfUpdateHypermedia: MediatorRdfUpdateHypermedia

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

`Protected`getDefaultLogData

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

getDestination

getDestination(context: IActionContext): Promise<IQuadDestination>
Get a destination instance for the given context.
Parameters
- context: IActionContext
  Optional context data.
Returns Promise<IQuadDestination>
A promise that resolves to a destination.
Overrides ActorRdfUpdateQuadsDestination.getDestination
- Defined in actor-rdf-update-quads-hypermedia/lib/ActorRdfUpdateQuadsHypermedia.ts:59

`Protected`getOutput

getOutput(
destination: IQuadDestination,
action: IActionRdfUpdateQuads,
): Promise<IActorRdfUpdateQuadsOutput>
Get the output of the given action on a destination.
Parameters
- destination: IQuadDestination
  A quad destination, possibly lazy.
- action: IActionRdfUpdateQuads
  The action.
Returns Promise<IActorRdfUpdateQuadsOutput>
Inherited from ActorRdfUpdateQuadsDestination.getOutput
- Defined in bus-rdf-update-quads/lib/ActorRdfUpdateQuadsDestination.ts:56

`Protected`logDebug

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

`Protected`logError

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

`Protected`logFatal

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

`Protected`logInfo

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

`Protected`logTrace

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

`Protected`logWarn

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

run

run(action: IActionRdfUpdateQuads): Promise<IActorRdfUpdateQuadsOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionRdfUpdateQuads
  The action to run.
Returns Promise<IActorRdfUpdateQuadsOutput>
A promise that resolves to the run result.
Inherited from ActorRdfUpdateQuadsDestination.run
- Defined in bus-rdf-update-quads/lib/ActorRdfUpdateQuadsDestination.ts:46

runObservable

runObservable(
action: IActionRdfUpdateQuads,
sideData: undefined,
): Promise<IActorRdfUpdateQuadsOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionRdfUpdateQuads
  The action to run.
- sideData: undefined
Returns Promise<IActorRdfUpdateQuadsOutput>
A promise that resolves to the run result.
Inherited from ActorRdfUpdateQuadsDestination.runObservable
- Defined in core/lib/Actor.ts:89

test

test(action: IActionRdfUpdateQuads): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionRdfUpdateQuads
  The action to test.
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorRdfUpdateQuadsDestination.test
- Defined in actor-rdf-update-quads-hypermedia/lib/ActorRdfUpdateQuadsHypermedia.ts:51

`Static`getContextLogger

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

Class ActorRdfUpdateQuadsHypermedia

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorRdfUpdateQuadsHypermedia

Properties

ReadonlybeforeActors

Readonlybus

Optional Readonlycache

ReadonlycacheSize

ReadonlyhttpInvalidator

ReadonlymediatorDereferenceRdf

ReadonlymediatorMetadata

ReadonlymediatorMetadataExtract

ReadonlymediatorRdfUpdateHypermedia

Readonlyname

Default

Methods

ProtectedgetDefaultLogData

Parameters

Returns any

getDestination

Parameters

Returns Promise<IQuadDestination>

ProtectedgetOutput

Parameters

Returns Promise<IActorRdfUpdateQuadsOutput>

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

runObservable

Parameters

Returns Promise<IActorRdfUpdateQuadsOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns Logger | undefined

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Optional` `Readonly`cache

`Readonly`cacheSize

`Readonly`httpInvalidator

`Readonly`mediatorDereferenceRdf

`Readonly`mediatorMetadata

`Readonly`mediatorMetadataExtract

`Readonly`mediatorRdfUpdateHypermedia

`Readonly`name

`Protected`getDefaultLogData

`Protected`getOutput

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger