Interface IActorContextPreprocessConvertShortcutsArgs

interface IActorContextPreprocessConvertShortcutsArgs {
    beforeActors?: Actor<
        IActionContextPreprocess,
        IActorTest,
        IActorContextPreprocessOutput,
        undefined,
    >[];
    bus: Bus<
        Actor<
            IActionContextPreprocess,
            IActorTest,
            IActorContextPreprocessOutput,
            undefined,
        >,
        IActionContextPreprocess,
        IActorTest,
        IActorContextPreprocessOutput,
        undefined,
    >;
    busFailMessage?: string;
    contextKeyShortcuts: Record<string, string>;
    name: string;
}

Hierarchy (View Summary)

Properties

beforeActors? bus busFailMessage? contextKeyShortcuts name

Properties

OptionalbeforeActors

beforeActors?: Actor<
    IActionContextPreprocess,
    IActorTest,
    IActorContextPreprocessOutput,
    undefined,
>[]

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

bus

bus: Bus<
    Actor<
        IActionContextPreprocess,
        IActorTest,
        IActorContextPreprocessOutput,
        undefined,
    >,
    IActionContextPreprocess,
    IActorTest,
    IActorContextPreprocessOutput,
    undefined,
>

The bus this actor subscribes to.

OptionalbusFailMessage

busFailMessage?: string

The message that will be configured in the bus for reporting failures.

This message may be a template string that contains references to the executed action. For example, the following templated string is allowed: "RDF dereferencing failed: no actors could handle ${action.handle.mediaType}"

contextKeyShortcuts

contextKeyShortcuts: Record<string, string>

A record of context shortcuts to full context keys (as defined in @comunica/context-entries).

Range

Default

{{
   *   "sources": "@comunica/actor-init-query:querySourcesUnidentified",
   *   "destination": "@comunica/bus-rdf-update-quads:destination",
   *   "initialBindings": "@comunica/actor-init-query:initialBindings",
   *   "queryFormat": "@comunica/actor-init-query:queryFormat",
   *   "baseIRI": "@comunica/actor-init-query:baseIRI",
   *   "log": "@comunica/core:log",
   *   "datetime": "@comunica/actor-http-memento:datetime",
   *   "queryTimestamp": "@comunica/actor-init-query:queryTimestamp",
   *   "queryTimestampHighResolution": "@comunica/actor-init-query:queryTimestampHighResolution",
   *   "httpProxyHandler": "@comunica/actor-http-proxy:httpProxyHandler",
   *   "lenient": "@comunica/actor-init-query:lenient",
   *   "httpIncludeCredentials": "@comunica/bus-http:include-credentials",
   *   "httpAuth": "@comunica/bus-http:auth",
   *   "httpTimeout": "@comunica/bus-http:http-timeout",
   *   "httpBodyTimeout": "@comunica/bus-http:http-body-timeout",
   *   "httpRetryCount": "@comunica/bus-http:http-retry-count",
   *   "httpRetryDelayFallback": "@comunica/bus-http:http-retry-delay-fallback",
   *   "httpRetryDelayLimit": "@comunica/bus-http:http-retry-delay-limit",
   *   "fetch": "@comunica/bus-http:fetch",
   *   "recoverBrokenLinks": "@comunica/bus-http-wayback:recover-broken-links",
   *   "readOnly": "@comunica/bus-query-operation:readOnly",
   *   "extensionFunctions": "@comunica/actor-init-query:extensionFunctions",
   *   "extensionFunctionCreator": "@comunica/actor-init-query:extensionFunctionCreator",
   *   "functionArgumentsCache": "@comunica/actor-init-query:functionArgumentsCache",
   *   "explain": "@comunica/actor-init-query:explain",
   *   "unionDefaultGraph": "@comunica/bus-query-operation:unionDefaultGraph",
   *   "traverse": "@comunica/bus-query-source-identify:traverse",
   *   "invalidateCache": "@comunica/actor-init-query:invalidateCache",
   *   "dataFactory": "@comunica/actor-init-query:dataFactory",
   *   "distinctConstruct": "@comunica/actor-init-query:distinctConstruct"
   * }}

name

name: string

The name for this actor.

Default

{<rdf:subject>}

Settings

Member Visibility

On This Page

Properties