gunshi / context / createCommandContext

Function: createCommandContext()

function createCommandContext<G, V, C, E>(param): Promise<object extends ExtractExtensions<E> ? Readonly<CommandContext<G>> : Readonly<CommandContext<GunshiParams<{
  args: ExtractArgs<G>;
  extensions: ExtractExtensions<E>;
}>>>>;

Create a command context.

Type Parameters

Type Parameter	Default type
G extends GunshiParamsConstraint	DefaultGunshiParams
V extends object	ArgValues<ExtractArgs<G>>
C extends | Command<G> | LazyCommand<G>	Command<G>
E extends Record<string, CommandContextExtension<{ }>>	object

Parameters

Parameter	Type	Description
param	CommandContextParams<G, V, C, E>	A parameters to create a command context.

Returns

Promise<object extends ExtractExtensions<E> ? Readonly<CommandContext<G>> : Readonly<CommandContext<GunshiParams<{ args: ExtractArgs<G>; extensions: ExtractExtensions<E>; }>>>>

A command context, which is readonly.