Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Properly indent the list of options #105

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Properly indent the list of options #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,27 +61,27 @@ cli.parse({
Below is a list of the return types followed by a description and a list of
valid values you can use for this option to get desired type of Object back.
- **as-is:** What you enter, is what you get
- 'string', 1, true
- **int:** Is converted to an Integer wrapped in a Number Object
- 'int', 'number', 'num',
- 'time', 'seconds', 'secs', 'minutes', 'mins'
- 'x', 'n'
- **date:** Is converted to a Date Object
- 'date', 'datetime', 'date_time'
- 'string', 1, true
- **int:** Is converted to an Integer wrapped in a Number Object
- 'int', 'number', 'num',
- 'time', 'seconds', 'secs', 'minutes', 'mins'
- 'x', 'n'
- **date:** Is converted to a Date Object
- 'date', 'datetime', 'date_time'
- **float:** Is converted to a Float wrapped in a Number Object
- 'float', 'decimal'
- 'float', 'decimal'
- **file:** Is converted to a String Object if it is a valid path
- 'path', 'file', 'directory', 'dir'
- 'path', 'file', 'directory', 'dir'
- **email:** Converted to a String Object if it is a valid email format
- 'email'
- 'email'
- **url:** Converted to a String Object if it is a valid URL format
- 'url', 'uri', 'domain', 'host'
- **ip:** Converted to a String Object if it is a valid IP Address format
- 'ip'
- **true:** Converted to true if argument is present on command line
- 'bool', 'boolean', 'on'
- 'url', 'uri', 'domain', 'host'
- **ip:** Converted to a String Object if it is a valid IPv4 Address format
- 'ip'
- **true:** Converted to true if argument is present on command line
- 'bool', 'boolean', 'on'
- **false:** Converted to false if argument is present on command line
- 'false', 'off', false, 0
- 'false', 'off', false, 0
4. A default value for this option if one is not given on the command line

## Helper methods
Expand Down