Skip to main content
Version: 1.x

CommandKitEnvironmentInternalData

CommandKitEnvironmentInternalData​

commandkitenvironment.ts

Represents the internal data structure for the CommandKit environment.

Signature
interface CommandKitEnvironmentInternalData {
    executionError: Error | null;
    type: CommandKitEnvironmentType | null;
    variables: Map<string, any>;
    deferredFunctions: Map<string, GenericFunction<[CommandKitEnvironment]>>;
    marker: string;
    markStart: number;
    markEnd: number;
    context: Context | null;
    store: Collection<any, any>;
}

executionError​

property
Error | null

The error that occurred during command execution, if any. This is set when an error occurs during the execution of a command.

type​

property
CommandKitEnvironmentType | null

The type of the environment, which can be used to differentiate between different execution contexts (e.g., command handler, event handler, etc.).

variables​

property
Map<string, any>

A map of variables that can be used to store and retrieve data during command execution. This allows for sharing data between different parts of the command execution process.

deferredFunctions​

property
Map<string, GenericFunction<[CommandKitEnvironment]>>

A map of deferred functions that will be executed after the command has finished executing. This is useful for running cleanup tasks or additional processing after the main command logic.

marker​

property
string

A marker string that can be used to identify the command execution. This is useful for logging and debugging purposes.

markStart​

property
number

The start time of the command execution.

markEnd​

property
number

The end time of the command execution.

context​

property
Context | null

The context associated with the command execution. This can be used to access request-specific data or application state.

store​

property
Collection<any, any>

Shared collection instance for arbitrary data storage