Class ActorExtractLinks<TS>Abstract

A comunica actor for extract-links events.

Actor types:

  • Input: IActionExtractLinks: Metdata from which links can be extracted.
  • Test:
  • Output: IActorExtractLinksOutput: The extracted links.

See

  • IActionExtractLinks
  • IActorExtractLinksOutput

Type Parameters

  • TS = undefined

Hierarchy (View Summary)

Constructors

constructor

Properties

beforeActors bus name

Methods

getDefaultLogData logDebug logError logFatal logInfo logTrace logWarn run runObservable test collectStream getContextLogger

Constructors

constructor

Properties

ReadonlybeforeActors

beforeActors: Actor<
    IActionExtractLinks,
    IActorTest,
    IActorExtractLinksOutput,
    TS,
>[]

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

Readonlybus

bus: Bus<
    Actor<IActionExtractLinks, IActorTest, IActorExtractLinksOutput, TS>,
    IActionExtractLinks,
    IActorTest,
    IActorExtractLinksOutput,
    TS,
>

The bus this actor subscribes to.

Readonlyname

name: string

The name for this actor.

Default

{<rdf:subject>}

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: IActionExtractLinks,
        sideData: TS,
    ): Promise<IActorExtractLinksOutput>

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

    A promise that resolves to the run result.

runObservable

Abstracttest

  • test(action: IActionExtractLinks): 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.

StaticcollectStream

  • collectStream(
        metadata: Stream,
        onQuad: (quad: Quad, links: ILink[]) => void,
    ): Promise<ILink[]>

  • A helper function to append links based on incoming quads.

    Parameters

    • metadata: Stream

      A metadata stream of quads.

    • onQuad: (quad: Quad, links: ILink[]) => void

      A callback that will be invoked for each quad in the metadata stream. The second argument is the array of links that can be appended to.

    Returns Promise<ILink[]>

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