New:Microsoft Teams Notifications Are Now Available in Socket.Learn more →
Get Started

@inquirer/number

Package Overview
Dependencies
Maintainers
2
Versions
59
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@inquirer/number

Inquirer number prompt

latest
Source
npmnpm
Version
4.2.4
Version published
Weekly downloads
43M
14.08%
Maintainers
2
Weekly downloads
 
Created
Source

@inquirer/number

Interactive free number input component for command line interfaces. Supports validation, filtering, transformation, etc.

Installation

yarnpnpm
yarn add @inquirer/prompts
pnpm add @inquirer/prompts
bundeno
bun add @inquirer/prompts
deno add npm:@inquirer/prompts
npm
npm install @inquirer/prompts
Or
yarnpnpm
yarn add @inquirer/number
pnpm add @inquirer/number
bundeno
bun add @inquirer/number
deno add npm:@inquirer/number
npm
npm install @inquirer/number

On Deno, prompts detect the terminal's unicode and color support from the environment, so run your script with --allow-env.

Usage

import { number } from '@inquirer/prompts';
// Or
// import number from '@inquirer/number';

const answer = await number({ message: 'Enter your age' });

Options

PropertyTypeRequiredDescription
messagestringyesThe question to ask
defaultnumbernoDefault value if no answer is provided (clear it by pressing backspace)
minnumbernoThe minimum value to accept for this input.
maxnumbernoThe maximum value to accept for this input.
stepnumber | 'any'noThe step option is a number that specifies the granularity that the value must adhere to. Only values which are equal to the basis for stepping (min if specified) are valid. This value defaults to 1, meaning by default the prompt will only allow integers.
requiredbooleannoDefaults to false. If set to true, undefined (empty) will not be accepted for this.
validate(number | undefined) => boolean | string | Promise<boolean | string>noOn submit, validate the filtered answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash.
themeSee ThemingnoCustomize look of the prompt.

Theming

You can theme a prompt by passing a theme object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.

type Theme = {
  prefix: string | { idle: string; done: string };
  spinner: {
    interval: number;
    frames: string[];
  };
  style: {
    answer: (text: string) => string;
    message: (text: string, status: 'idle' | 'done' | 'loading') => string;
    error: (text: string) => string;
    defaultAnswer: (text: string) => string;
  };
};

License

Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.

Keywords

answer

FAQs

Package last updated on 04 Oct 2026

Related posts