Components

Date

Usage

const date = await io.input.date('Start subscription date')
console.log(date) // '2024-01-14'

Parameters

labelrequired
string

The label to render above the input.

options { ... }
defaultValue
string

Default value rendered in input. Default ''.

min
string | undefined

The earliest date that can be selected. Default undefined.

max
string | undefined

The latest date that can be selected. Default undefined.

step
number

Affects the available dates presented to the user. Default 1.

disabled
boolean

Disables user input. Default false.

help
string

The small help text to render below the input. Default undefined.

customValidator
(input: unknown) => Promise<string | true>

An asynchronous function that takes unknown input and outputs either true or an error message string to show the user.