Interface ICliExecutionContext

Represents the context in which a command is executed

interface ICliExecutionContext {
    clipboard: ICliClipboard;
    executor: ICliCommandExecutorService;
    logger: ICliLogger;
    onAbort: Subject<void>;
    options?: CliOptions;
    process: ICliExecutionProcess;
    progressBar: ICliPercentageProgressBar;
    services: ICliServiceProvider;
    setContextProcessor: (
        processor: ICliCommandProcessor,
        silent?: boolean,
    ) => void;
    showPrompt: () => void;
    spinner?: ICliSpinner;
    state: ICliStateStore;
    terminal: Terminal;
    textAnimator?: ICliTextAnimator;
    userSession?: ICliUserSession;
    writer: ICliTerminalWriter;
}

Properties

clipboard executor logger onAbort options? process progressBar services setContextProcessor showPrompt spinner? state terminal textAnimator? userSession? writer

Properties

clipboard

clipboard: ICliClipboard

The clipboard to use for copying/pasting

executor

executor: ICliCommandExecutorService

The command executor to use for executing commands

logger

logger: ICliLogger

The logger to use for logging

onAbort

onAbort: Subject<void>

A subject that emits when the command is aborted

Optionaloptions

options?: CliOptions

The options for the CLI

process

process: ICliExecutionProcess

The process to use for exiting the CLI

progressBar

progressBar: ICliPercentageProgressBar

The progress bar to use for showing progress

services

services: ICliServiceProvider

The services to use for the CLI context

setContextProcessor

setContextProcessor: (processor: ICliCommandProcessor, silent?: boolean) => void

Set the current processor as the context processor, i.e. the processor that will handle the command

Type declaration

    • (processor: ICliCommandProcessor, silent?: boolean): void

    • Parameters

      • processor: ICliCommandProcessor

        The processor to set

      • Optionalsilent: boolean

        Indicates if the setting should be silent, i.e. not write to the terminal

      Returns void

showPrompt

showPrompt: () => void

The prompt to use for prompting the user for input

Optionalspinner

spinner?: ICliSpinner

The spinner to use for showing/hiding the loader

state

state: ICliStateStore

The state store to use for storing state

terminal

terminal: Terminal

The terminal to use for writing

OptionaltextAnimator

textAnimator?: ICliTextAnimator

The text animator to use for showing/hiding text

OptionaluserSession

userSession?: ICliUserSession

The current user session

writer

writer: ICliTerminalWriter

The writer to use for writing to the terminal

Settings

Member Visibility

On This Page

Properties