Interface ParamDescriptor

Description

A single declared action parameter in the params export of a class-based action hook module. The declaration drives flag coercion, prompt generation (for parameters not supplied via flags) and post-prompt validation.

interface ParamDescriptor {
    default?: unknown;
    message?: string;
    name: string;
    required?: boolean;
    type: ParamType;
}

Properties

default?: unknown

Description

Default value used as the prompt's initial answer.

message?: string

Description

Prompt question text for an unanswered required parameter.

name: string

Description

The parameter (flag) name, also used as the local/args key.

required?: boolean

Description

Whether the parameter must be supplied or answered.

type: ParamType

Description

The parameter type: a registry name or a resolver function.