Class ActorIteratorTransform<TS>`Abstract`

A comunica actor for transform-iterator events.

Actor types: Input: IActionIteratorTransform: Data that denotes what type of stream is being wrapped, what actor produced this stream, and the stream itself

Test:
Output: IActorIteratorTransformOutput: The transformed stream and additional metadata.

See

IActionIteratorTransform
IActorIteratorTransformOutput

Type Parameters

TS = undefined

Hierarchy (View Summary)

Actor<ActionIteratorTransform, IActorTest, ActorIteratorTransformOutput, TS>
- ActorIteratorTransform
  - ActorIteratorTransformRecordIntermediateResults

Index

Constructors

constructor

new ActorIteratorTransform<TS = undefined>(
args: IActorIteratorTransformArgs<TS>,
): ActorIteratorTransform<TS>
Type Parameters
- TS = undefined
Parameters
- args: IActorIteratorTransformArgs<TS>
Returns ActorIteratorTransform<TS>
Default Nested
bus
Overrides Actor.constructor
- Defined in bus-iterator-transform/lib/ActorIteratorTransform.ts:26

Properties

`Readonly`beforeActors

beforeActors: Actor<
    ActionIteratorTransform,
    IActorTest,
    ActorIteratorTransformOutput,
    TS,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        ActionIteratorTransform,
        IActorTest,
        ActorIteratorTransformOutput,
        TS,
    >,
    ActionIteratorTransform,
    IActorTest,
    ActorIteratorTransformOutput,
    TS,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

wraps

wraps: possibleOperationTypes[]

Methods

`Protected`getDefaultLogData

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

`Protected`logDebug

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

run

run(action: ActionIteratorTransform): Promise<ActorIteratorTransformOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: ActionIteratorTransform
  The action to run.
Returns Promise<ActorIteratorTransformOutput>
A promise that resolves to the run result.
Overrides Actor.run
- Defined in bus-iterator-transform/lib/ActorIteratorTransform.ts:30

runObservable

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

test

test(action: ActionIteratorTransform): Promise<TestResult<IActorTest, TS>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: ActionIteratorTransform
  The action to test.
Returns Promise<TestResult<IActorTest, TS>>
A promise that resolves to the test result.
Overrides Actor.test
- Defined in bus-iterator-transform/lib/ActorIteratorTransform.ts:55

`Protected` `Abstract`testIteratorTransform

testIteratorTransform(
action: ActionIteratorTransform,
): Promise<TestResult<IActorTest, TS>>
Parameters
- action: ActionIteratorTransform
Returns Promise<TestResult<IActorTest, TS>>
- Defined in bus-iterator-transform/lib/ActorIteratorTransform.ts:64

`Abstract`transformIteratorBindings

transformIteratorBindings(
action: IActionIteratorTransformBindings,
): Promise<
ITransformIteratorOutput<AsyncIterator<Bindings>, MetadataBindings>,
>
Parameters
- action: IActionIteratorTransformBindings
Returns Promise<ITransformIteratorOutput<AsyncIterator<Bindings>, MetadataBindings>>
- Defined in bus-iterator-transform/lib/ActorIteratorTransform.ts:67

`Abstract`transformIteratorQuads

transformIteratorQuads(
action: IActionIteratorTransformQuads,
): Promise<ITransformIteratorOutput<AsyncIterator<Quad>, MetadataQuads>>
Parameters
- action: IActionIteratorTransformQuads
Returns Promise<ITransformIteratorOutput<AsyncIterator<Quad>, MetadataQuads>>
- Defined in bus-iterator-transform/lib/ActorIteratorTransform.ts:70

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

Class ActorIteratorTransform<TS>Abstract

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ActorIteratorTransform<TS>

Default Nested

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

wraps

Methods

ProtectedgetDefaultLogData

Parameters

Returns any

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

runObservable

Parameters

Returns Promise<ActorIteratorTransformOutput>

test

Parameters

Returns Promise<TestResult<IActorTest, TS>>

Protected AbstracttestIteratorTransform

Parameters

Returns Promise<TestResult<IActorTest, TS>>

AbstracttransformIteratorBindings

Parameters

Returns Promise<ITransformIteratorOutput<AsyncIterator<Bindings>, MetadataBindings>>

AbstracttransformIteratorQuads

Parameters

Returns Promise<ITransformIteratorOutput<AsyncIterator<Quad>, MetadataQuads>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

Class ActorIteratorTransform<TS>`Abstract`

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Protected` `Abstract`testIteratorTransform

`Abstract`transformIteratorBindings

`Abstract`transformIteratorQuads

`Static`getContextLogger