Skip to content

Interface: GunshiParams<P>

Gunshi unified parameter type.

This type combines both argument definitions and command context extensions.

Since

v0.27.0

Signature

ts
export interface GunshiParams<
  P extends {
    args?: Args
    extensions?: ExtendContext
  } = {
    args: Args
    extensions: {}
  }
>

Type Parameters

NameDescription
P extends { args?: Args extensions?: ExtendContext } = { args: Args extensions:The type of parameters, which can include args and extensions.

Properties

NameTypeDescription
argsP extends { args: infer A extends Args } ? A : ArgsCommand argument definitions.
extensionsP extends { extensions: infer E extends ExtendContext } ? E : {}Command context extensions.

Released under the MIT License.