npm 包 @types/readline-sync 使用教程

在前端开发中，我们常常需要在命令行中读取用户的输入。而 readline-sync 就是一个能够实现这个功能的库，它可以很方便的读取用户在控制台中的输入。

在 TypeScript 项目中使用 readline-sync 时，我们需要安装依赖 npm 包 @types/readline-sync。

安装

使用以下命令进行安装：

npm install @types/readline-sync

导入 readline-sync

安装完成后，在需要使用该库的文件中导入 readline-sync：

import * as readlineSync from 'readline-sync';

使用

读取用户输入

使用 following 代码读取用户输入：

// 同步读取用户输入
const name: string = readlineSync.question('请输入你的名字: ');
console.log(`你好, ${name}!`);

以上代码中，我们使用 readlineSync 中的方法 question，它会在控制台中显示参数中的提示信息 请输入你的名字:，等待用户输入后将输入的结果返回，并赋值给变量 name。

设置默认值

question 方法也支持给定默认值。使用 following 代码即可：

const name: string = readlineSync.question('请输入你的名字: ', { defaultInput: 'clark' });
console.log(`你好, ${name}!`);

以上代码中，我们给定了默认值为 clark，当用户没有输入任何值时，将使用默认值。

控制台选择

readline-sync 还提供了 keyInSelect 方法，它可以让用户在选项中选择。使用 following 代码：

const items: Array<string> = ['item1', 'item2', 'item3'];
const index: number = readlineSync.keyInSelect(items, '请选择');
console.log(`你选中了 ${items[index]}`);

以上代码中，我们使用了 keyInSelect 方法，它让用户从给定的选项中进行选择，选择完成后将返回选项的下标。在以上例子中，我们给定了选项数组为 ['item1', 'item2', 'item3']，选择提示信息为 请选择。

readline-sync 还提供了许多其他的方法，可在 官方文档 中查看。

总结

使用 readline-sync 可以使我们在命令行中读取用户输入非常方便。在 TypeScript 项目中，我们需要安装依赖 npm 包 @types/readline-sync，并导入 readline-sync 即可使用其提供的功能。readline-sync 还提供了许多其他的方法，在使用时需详细查阅官方文档，以便更好的使用。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc1a2b5cbfe1ea0611e7c