node-lxc
    Preparing search index...

    Interface ExecSession

    Streaming exec session returned by Container.execAsync.

    Register listeners before yielding control back to the event loop so no output is missed. The session closes automatically when the process exits.

    interface ExecSession {
        get closed(): boolean;
        kill(signal?: number): void;
        on(event: "stdout", listener: (chunk: Buffer) => void): this;
        on(event: "stderr", listener: (chunk: Buffer) => void): this;
        on(event: "exit", listener: (exitCode: number) => void): this;
    }
    Index

    Accessors

    closed

    Methods

    kill on

    Accessors

    Methods

    • Send a signal to the attached process.

      Parameters

      • Optionalsignal: number

        Signal number (default: SIGTERM = 15).

      Returns void

    • Subscribe to a stdout chunk, stderr chunk, or process exit.

      Parameters

      • event: "stdout"
      • listener: (chunk: Buffer) => void

      Returns this

    • Parameters

      • event: "stderr"
      • listener: (chunk: Buffer) => void

      Returns this

    • Parameters

      • event: "exit"
      • listener: (exitCode: number) => void

      Returns this

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods