Package Exports
- inquirer-datepicker
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (inquirer-datepicker) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
inquirer-datepicker
Datepicker plugin for Inquirer.js
Getting started
install plugin
register prompt
inquirer.registerPrompt('datepicker', require('inquirer-datepicker'));Options
message
Inherited from inquirer, message to be displayed while retrieving response.
format
An array of format specifiers for printing the date to the console.
Uses the moment format options.
For example:
// 2017/09/26 22:56:36
{
type: 'datepicker',
name: 'date',
message: 'Select a date time: ',
format: ['Y', '/', 'MM', '/', 'DD', ' ', 'HH', ':', 'mm', ':', 'ss']
}
// 2017/09/26 10:56:36 PM
{
type: 'datepicker',
name: 'date',
message: 'Select a date time: ',
format: ['Y', '/', 'MM', '/', 'DD', ' ', 'hh', ':', 'mm', ':', 'ss', ' ', 'A']
}default
Initial value for datepicker.
Example:
{
type: 'datepicker',
name: 'date',
message: 'Select a date time: ',
default: new Date('2017-09-28 17:36:05'),
}min, max
These specify a range for entry. Users will be prohibited from entering a value higher or lower.
{
type: 'datepicker',
name: 'date',
message: 'Select a date time: ',
// Enter only 2017/9/1 6:00 to 2017/9/26 18:00
min: {
year: 2017,
month: 9,
day: 1,
hour: 6
},
max: {
year: 2017,
month: 9,
day: 26,
hour: 18
}
}steps.{ years, months, days, hours, minutes, seconds }
These specify the allowed interval (modulo), but only work when useing up and down keys.
For instance:
// Minutes can only be entered in intervals of 15 minutes
{
type: 'datepicker',
name: 'date',
message: 'Select a date time: ',
steps: {
minutes: 15
}
}