Interface ILink

A link holder that can expose additional properties.

interface ILink {
    context?: IActionContext;
    metadata?: Record<string, any>;
    transform?: ((input) => Promise<Stream<Quad>>);
    url: string;
}

Properties

context? metadata? transform? url

Properties

Optional context

context?: IActionContext

Optional context to apply onto mediators when handling this link as source. All entries of this context will be added (or overwritten) into the existing context.

Optional metadata

metadata?: Record<string, any>

An optional link-specific metadata object. This may be used to keep track of data that is relevant to links, which could be used across actors.

Optional transform

transform?: ((input) => Promise<Stream<Quad>>)

An optional stream modifier. This transformation will be applied on the stream of data quads that is obtained from dereferencing the given URL.

Type declaration

    • (input): Promise<Stream<Quad>>

    • Parameters

      • input: Stream<Quad>

        The stream of data quads on the given URL.

      Returns Promise<Stream<Quad>>

Returns

The stream of data quads to be used for this link instead of the given stream.

url

url: string

The URL identifying this link.

Settings

Member Visibility

Theme

On This Page

contextmetadatatransformurl