Module: option

Classes

• MassargOption
• MassargNumber
• MassargFlag
• MassargHelpFlag

Type Aliases

OptionConfig

Ƭ OptionConfig<T, Args>: z.infer<ReturnType<typeof OptionConfig>>

Type parameters

Name	Type
T	unknown
Args	extends ArgsObject = ArgsObject

Defined in

src/option.ts:6

src/option.ts:47

---

FlagConfig

Ƭ FlagConfig: z.infer<typeof FlagConfig>

Defined in

src/option.ts:54

src/option.ts:78

---

Parser

Ƭ Parser<Args, OptionType>: (x: string, y: Args) => OptionType

A function that parses an option value.

Type parameters

Name	Type
Args	extends ArgsObject = ArgsObject
OptionType	extends any = any

Type declaration

▸ (x, y): OptionType

Parameters

Name	Type
x	string
y	Args

Returns

OptionType

Defined in

src/option.ts:83

---

TypedOptionConfig

Ƭ TypedOptionConfig<T, A>: z.infer<ReturnType<typeof TypedOptionConfig>>

Type parameters

Name	Type
T	T
A	extends ArgsObject = ArgsObject

Defined in

src/option.ts:89

src/option.ts:97

---

ArrayOptionConfig

Ƭ ArrayOptionConfig<T>: z.infer<ReturnType<typeof ArrayOptionConfig>>

An option that can be passed to a command.

This type represents an array option, which can be specified multiple times.

Type parameters

Name	Type
T	unknown

Defined in

src/option.ts:105

src/option.ts:118

---

Prefixes

Ƭ Prefixes: Object

Type declaration

Name	Type
normalPrefix	string
aliasPrefix	string

Defined in

src/option.ts:128

---

Names

Ƭ Names: Object

Type declaration

Name	Type
name	string
aliases	string[]

Defined in

src/option.ts:134

---

QualifiedNames

Ƭ QualifiedNames: Object

Names with prefixes built-in

Type declaration

Name	Type
name	string
aliases	string[]
negationName	string
negationAliases	string[]

Defined in

src/option.ts:140

Variables

FlagConfig

• Const FlagConfig: ZodObject<{ name: ZodString ; description: ZodString ; defaultValue: ZodOptional<ZodAny> ; aliases: ZodArray<ZodString> ; array: ZodOptional<ZodBoolean> ; required: ZodOptional<ZodBoolean> ; hidden: ZodOptional<ZodBoolean> ; outputName: ZodOptional<ZodString> ; negatable: ZodOptional<ZodBoolean> ; negationName: ZodOptional<ZodString> ; negationAliases: ZodOptional<ZodArray<ZodString>> }, $strip>

Configuration for a flag (boolean argument) that can be passed to a command.

Defined in

src/option.ts:54

src/option.ts:78

---

DEFAULT_OPT_FULL_PREFIX

• Const DEFAULT_OPT_FULL_PREFIX: "--"

The default prefixes for options

Defined in

src/option.ts:123

---

DEFAULT_OPT_SHORT_PREFIX

• Const DEFAULT_OPT_SHORT_PREFIX: "-"

The default prefix for option aliases

Defined in

src/option.ts:125

Functions

OptionConfig

▸ OptionConfig<OptionType, Args>(type): ZodObject<{ name: ZodString ; description: ZodString ; defaultValue: ZodOptional<ZodAny> ; aliases: ZodArray<ZodString> ; parse: ZodOptional<ZodType<Parser<Args, OptionType>, unknown, $ZodTypeInternals<Parser<Args, OptionType>, unknown>>> ; array: ZodOptional<ZodBoolean> ; required: ZodOptional<ZodBoolean> ; isDefault: ZodOptional<ZodBoolean> ; hidden: ZodOptional<ZodBoolean> ; outputName: ZodOptional<ZodString> }, $strip>

Type parameters

Name	Type
OptionType	OptionType
Args	extends ArgsObject = ArgsObject

Parameters

Name	Type
type	ZodType<OptionType, unknown, $ZodTypeInternals<OptionType, unknown>>

Returns

ZodObject<{ name: ZodString ; description: ZodString ; defaultValue: ZodOptional<ZodAny> ; aliases: ZodArray<ZodString> ; parse: ZodOptional<ZodType<Parser<Args, OptionType>, unknown, $ZodTypeInternals<Parser<Args, OptionType>, unknown>>> ; array: ZodOptional<ZodBoolean> ; required: ZodOptional<ZodBoolean> ; isDefault: ZodOptional<ZodBoolean> ; hidden: ZodOptional<ZodBoolean> ; outputName: ZodOptional<ZodString> }, $strip>

Defined in

src/option.ts:6

---

TypedOptionConfig

▸ TypedOptionConfig<OptionType, Args>(type): ZodObject<{ name: ZodString ; description: ZodString ; defaultValue: ZodOptional<ZodAny> ; aliases: ZodArray<ZodString> ; parse: ZodOptional<ZodType<Parser<Args, OptionType>, unknown, $ZodTypeInternals<Parser<Args, OptionType>, unknown>>> ; array: ZodOptional<ZodBoolean> ; required: ZodOptional<ZodBoolean> ; isDefault: ZodOptional<ZodBoolean> ; hidden: ZodOptional<ZodBoolean> ; outputName: ZodOptional<ZodString> ; type: ZodOptional<ZodEnum<{ number: "number" }>> }, $strip>

OptionConfig with a specified value type

Type parameters

Name	Type
OptionType	OptionType
Args	extends ArgsObject = ArgsObject

Parameters

Name	Type
type	ZodType<OptionType, unknown, $ZodTypeInternals<OptionType, unknown>>

Returns

ZodObject<{ name: ZodString ; description: ZodString ; defaultValue: ZodOptional<ZodAny> ; aliases: ZodArray<ZodString> ; parse: ZodOptional<ZodType<Parser<Args, OptionType>, unknown, $ZodTypeInternals<Parser<Args, OptionType>, unknown>>> ; array: ZodOptional<ZodBoolean> ; required: ZodOptional<ZodBoolean> ; isDefault: ZodOptional<ZodBoolean> ; hidden: ZodOptional<ZodBoolean> ; outputName: ZodOptional<ZodString> ; type: ZodOptional<ZodEnum<{ number: "number" }>> }, $strip>

Defined in

src/option.ts:89

---

ArrayOptionConfig

▸ ArrayOptionConfig<T, A>(type): ZodObject<{ name: ZodString ; description: ZodString ; aliases: ZodArray<ZodString> ; parse: ZodOptional<ZodType<Parser<A, T[]>, unknown, $ZodTypeInternals<Parser<A, T[]>, unknown>>> ; array: ZodOptional<ZodBoolean> ; required: ZodOptional<ZodBoolean> ; isDefault: ZodOptional<ZodBoolean> ; hidden: ZodOptional<ZodBoolean> ; outputName: ZodOptional<ZodString> ; type: ZodOptional<ZodEnum<{ number: "number" }>> ; defaultValue: ZodOptional<ZodArray<ZodType<T, unknown, $ZodTypeInternals<T, unknown>>>> }, $strip>

Type parameters

Name	Type
T	T
A	extends ArgsObject = ArgsObject

Parameters

Name	Type
type	ZodType<T, unknown, $ZodTypeInternals<T, unknown>>

Returns

ZodObject<{ name: ZodString ; description: ZodString ; aliases: ZodArray<ZodString> ; parse: ZodOptional<ZodType<Parser<A, T[]>, unknown, $ZodTypeInternals<Parser<A, T[]>, unknown>>> ; array: ZodOptional<ZodBoolean> ; required: ZodOptional<ZodBoolean> ; isDefault: ZodOptional<ZodBoolean> ; hidden: ZodOptional<ZodBoolean> ; outputName: ZodOptional<ZodString> ; type: ZodOptional<ZodEnum<{ number: "number" }>> ; defaultValue: ZodOptional<ZodArray<ZodType<T, unknown, $ZodTypeInternals<T, unknown>>>> }, $strip>

See

• OptionConfig
• ArrayOptionConfig

Defined in

src/option.ts:105