Class ActorSourceWatch<TS>Abstract

An Incremunica actor for source-watch events.

Actor types:

  • Input: IActionSourceWatch: The url and metadata of the source to watch.
  • Test: IActionSourceWatch: The url and metadata of the source to watch.
  • Output: IActorSourceWatchOutput: start and stop functions for the source watch, and an event emitter for 'update' and 'delete' events.

See

  • IActionSourceWatch
  • IActorSourceWatchOutput

Type Parameters

  • TS = undefined

Hierarchy (View Summary)

Constructors

constructor

Properties

beforeActors bus name priority

Methods

getDefaultLogData logDebug logError logFatal logInfo logTrace logWarn run runObservable test getContextLogger

Constructors

constructor

Properties

ReadonlybeforeActors

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

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

Readonlybus

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

The bus this actor subscribes to.

Readonlyname

name: string

The name for this actor.

Default

{<rdf:subject>}

Readonlypriority

priority: number

Methods

ProtectedgetDefaultLogData

  • getDefaultLogData(context: IActionContext, data?: () => any): any

  • Parameters

    • context: IActionContext
    • Optionaldata: () => any

    Returns any

ProtectedlogDebug

  • logDebug(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogError

  • logError(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogFatal

  • logFatal(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogInfo

  • logInfo(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogTrace

  • logTrace(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

ProtectedlogWarn

  • logWarn(context: IActionContext, message: string, data?: () => any): void

  • Parameters

    • context: IActionContext
    • message: string
    • Optionaldata: () => any

    Returns void

Abstractrun

  • run(action: IActionSourceWatch, sideData: TS): 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

    Returns Promise<IActorSourceWatchOutput>

    A promise that resolves to the run result.

runObservable

Abstracttest

  • test(action: IActionSourceWatch): Promise<TestResult<IActorTest, TS>>

  • Check if this actor can run the given action, without actually running it.

    Parameters

    Returns Promise<TestResult<IActorTest, TS>>

    A promise that resolves to the test result.

StaticgetContextLogger

  • 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.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods