Have ideas to improve npm?Join in the discussion! »

    inquirer-datepicker

    2.0.0 • Public • Published

    inquirer-datepicker

    Datepicker plugin for Inquirer.js

    Datetime prompt

    NPM Version Download Status Dependencies

    Getting started

    install plugin

    NPM

    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
      }
    }

    Thanks

    See: inquirer-datepicker-prompt

    Install

    npm i inquirer-datepicker

    DownloadsWeekly Downloads

    86,811

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    20.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar