@qui-cli/validators

@qui-cli Plugin: Input validators


Install

``sh
npm install @qui-cli/validators @inquirer/prompts
`

Usage

`ts
import { Validators } from '@qui-cli/validators';
import { input } from '@inquirer/prompts'

const word = await input({
message: 'Enter a decently long word'
default: 'quetzlcoatl',
validate: Validators.lengthBetween(8, 100)
})
`

Configuration

Validators provides no configuration options.

Options

Validators adds no user-configurable command line options.

Initialization

Validators requires no initialization

API

`ts
import { Validators } from '@qui-cli/validators';
`

$3

Require a non-empty string. Returns true if valid, an error message if invalid.

$3

Returns a validator that requires a string of at least minLength.

$3

Returns a validator that requires a string of no more than maxLength.

$3

Returns a validator that requires a string between min and max characters.

$3

Returns a validator that requires a string that matches regExp.

$3

Returns a validator that requires a valid email address.

$3

Requires a valid cron schedule string. Returns true if valid, an error message if invalid.

$3

Returns a validator that requires a valid hostname.

$3

Require a file path string. Returns true if valid, an error message if invalid.

$3

Returns a validator that requires a file path string that exists (relative to root, if root` is undefined, falls back to Root.path()).

$3

Returns a validator that combines any number of other validators (all must be met to valididate, first validator to fail returns an error message).