@comunica/bus-init/lib/ActorInit.d.ts

A comunica bus for 'init' events.

import type { IAction, IActorOutput, IActorTest, IActorArgs, Mediate } from '@comunica/core';
import { Actor } from '@comunica/core';
import type { Readable } from 'readable-stream';
/**
 * A base actor for listening to init events.
 *
 * Actor types:
 * * Input:  IActionInit:      Contains process information
 *                             such as the list of arguments,
 *                             environment variables and input stream.
 * * Test:   <none>
 * * Output: IActorOutputInit: Contains process output streams.
 *
 * @see IActionInit
 */
export declare abstract class ActorInit extends Actor<IActionInit, IActorTest, IActorOutputInit, undefined> {
    /**
     * @param args -
     *   \ @defaultNested {<default_bus> a <cc:components/Bus.jsonld#Bus>} bus
     *   \ @defaultNested {Initialization failed: none of the configured actors were to initialize} busFailMessage
     */
    constructor(args: IActorInitArgs);
}
/**
 * The init input, which contains the program arguments.
 */
export interface IActionInit extends IAction {
    /**
     * The list of program arguments.
     */
    argv: string[];
    /**
     * The mapping of environment variables.
     */
    env: Record<string, string | undefined>;
    /**
     * A standard input stream.
     */
    stdin: Readable;
}
export interface IActorOutputInit extends IActorOutput {
    /**
     * A standard error output stream.
     */
    stderr?: Readable;
    /**
     * A standard output stream.
     */
    stdout?: Readable;
}
export type IActorInitArgs = IActorArgs<IActionInit, IActorTest, IActorOutputInit>;
export type MediatorInit = Mediate<IActionInit, IActorOutputInit>;