gunshi / definition / defineWithTypes

Function: defineWithTypes()

function defineWithTypes<G>(): DefineWithTypesReturn<ExtractExtensions<G>, ExtractArgs<G>>;

Define a command with types

This helper function allows specifying the type parameter of GunshiParams while inferring the Args type, ExtendContext type from the definition.

Type Parameters

Type Parameter	Description
G extends GunshiParamsConstraint	A GunshiParams type

Returns

DefineWithTypesReturn<ExtractExtensions<G>, ExtractArgs<G>>

A function that takes a command definition via define

Example

// Define a command with specific extensions type
type MyExtensions = { logger: { log: (message: string) => void } }

const command = defineWithTypes<{ extensions: MyExtensions }>()({
  name: 'greet',
  args: {
    name: { type: 'string' }
  },
  run: ctx => {
    // ctx.values is inferred as { name?: string }
    // ctx.extensions is MyExtensions
  }
})

Since

v0.27.0