Class ActorSourceWatchPolling

An incremunica Polling Source Watch Actor.

Hierarchy (View Summary)

ActorSourceWatch
- ActorSourceWatchPolling

Index

Constructors

constructor

new ActorSourceWatchPolling(
args: IActorSourceWatchPollingArgs,
): ActorSourceWatchPolling
Parameters
- args: IActorSourceWatchPollingArgs
Returns ActorSourceWatchPolling
Overrides ActorSourceWatch.constructor
- Defined in packages/actor-source-watch-polling/lib/ActorSourceWatchPolling.ts:25

Properties

`Readonly`beforeActors

beforeActors: Actor<IActionSourceWatch, IActorTest, IActorSourceWatchOutput>[]

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

`Readonly`bus

bus: Bus<
    Actor<IActionSourceWatch, IActorTest, IActorSourceWatchOutput>,
    IActionSourceWatch,
    IActorTest,
    IActorSourceWatchOutput,
>

The bus this actor subscribes to.

`Readonly`defaultPollingPeriod

defaultPollingPeriod: number

`Readonly`mediatorHttp

mediatorHttp: MediatorHttp

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`priority

priority: number

Methods

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorSourceWatch.getDefaultLogData
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:69

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorSourceWatch.logDebug
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:71

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorSourceWatch.logError
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:74

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorSourceWatch.logFatal
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:75

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorSourceWatch.logInfo
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:72

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorSourceWatch.logTrace
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:70

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorSourceWatch.logWarn
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:73

run

run(action: IActionSourceWatch): Promise<IActorSourceWatchOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionSourceWatch
  The action to run.
Returns Promise<IActorSourceWatchOutput>
A promise that resolves to the run result.
Overrides ActorSourceWatch.run
- Defined in packages/actor-source-watch-polling/lib/ActorSourceWatchPolling.ts:33

runObservable

runObservable(
action: IActionSourceWatch,
sideData: undefined,
): Promise<IActorSourceWatchOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionSourceWatch
  The action to run.
- sideData: undefined
Returns Promise<IActorSourceWatchOutput>
A promise that resolves to the run result.
Inherited from ActorSourceWatch.runObservable
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:68

test

test(_action: IActionSourceWatch): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionSourceWatch
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorSourceWatch.test
- Defined in packages/actor-source-watch-polling/lib/ActorSourceWatchPolling.ts:29

`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 ActorSourceWatch.getContextLogger
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:42

Class ActorSourceWatchPolling

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorSourceWatchPolling

Properties

ReadonlybeforeActors

Readonlybus

ReadonlydefaultPollingPeriod

ReadonlymediatorHttp

Readonlyname

Default

Readonlypriority

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

runObservable

Parameters

Returns Promise<IActorSourceWatchOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`defaultPollingPeriod

`Readonly`mediatorHttp

`Readonly`name

`Readonly`priority

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger