import Option from '@ls-age/args-parser/src/Option.js'

public class | source

Option

Option definition that can be parse by Parser.

Constructor Summary

Public Constructor
public	constructor(descOrOptions: string \| Option.Options) Creates a new option based on a description or some options.

Public Members
public	alias: string The alias to use for the option.
public	description: string A short string describing the option.
public get	requiresValue: boolean Whether or not the option requires a value to be passed.
public	type: string The option's type. One of OptionType.

Public Methods
public	parsedValue(value: string): * Casts the given value to the appropriate type.

Creates a new option based on a description or some options. If a string is passed Option#type is set to OptionType.Boolean by default.

Name	Type	Attribute	Description
descOrOptions	string \| Option.Options		The description or options used to create the Option.

The alias to use for the option.

A short string describing the option.

Whether or not the option requires a value to be passed.

The option's type. One of OptionType.

Casts the given value to the appropriate type. If an invalid value is passed null is returned.

Name	Type	Attribute	Description
value	string		The value to parse.

* (nullable: true)

The parsed value or null.