ReadonlyArgvParser
interfaceinterface ReadonlyArgvParser<TArgs>Properties
| Name | Type | Description |
|---|---|---|
| configuredOptions | Readonly<{ [key in keyof TArgs]: InternalOptionConfig }> | — |
| configuredPositionals | readonly Readonly<InternalOptionConfig>[] | — |
| options | Readonly<Required<ParserOptions<TArgs>>> | — |
Methods
getConfigurationDocs(): ConfigurationDocSection[]Gets documentation sections for all configured configuration providers.
getDisplayKey(key: string): stringGets the display key for an option, which may be localized.
getEnvInfo(): { enabled: boolean; prefix?: string }Returns the environment variable configuration for this parser, used by documentation generation.
getLocalizationDictionary(): LocalizationDictionary | undefinedGets the localization dictionary if configured.
updateConfig(values: Partial<TArgs>): Promise<void>