随着前端领域的不断发展，前端工具库也变得越来越强大，其中 npm 包是现代前端项目中不可或缺的一部分。而在前端开发过程中，我们经常需要和数据库打交道，因此，今天我要向大家介绍一款 npm 包：sql2ts，它可以快速将 SQL 表结构转换为对应的 TypeScript 接口定义。
什么是 sql2ts？
sql2ts 是用 TypeScript 编写的一款 npm 包。它可以将常见的 SQL 数据表结构转换为对应的 TypeScript 接口定义。
安装
npm install sql2ts
使用
使用 sql2ts 很简单，只需要通过以下命令来执行：
npx sql2ts [options] <inputFile>
其中，<inputFile>是要转换的 SQL 文件路径。
示例
假设我们有如下 SQL 文件 users.sql：
CREATE TABLE IF NOT EXISTS users ( id INT NOT NULL AUTO_INCREMENT, name VARCHAR(50), email VARCHAR(50) NOT NULL, age INT, PRIMARY KEY (id) );
我们可以通过以下命令来将其转换为对应的 TypeScript 接口：
npx sql2ts users.sql
输出结果如下：
export interface Users {
id: number;
name?: string;
email: string;
age?: number;
}另外，我们也可以通过以下命令来生成一个 .d.ts 文件：
npx sql2ts users.sql -o users.d.ts
选项
除了基本的用法，sql2ts 还提供了一些选项，以方便我们进行自定义配置。
--camelCase
将表中的列名转换为驼峰式命名。
--pascalCase
将表中的列名转换为帕斯卡式命名。
示例
假设我们有如下 SQL 文件 users.sql：
CREATE TABLE IF NOT EXISTS users ( id INT NOT NULL AUTO_INCREMENT, first_name VARCHAR(50), last_name VARCHAR(50), PRIMARY KEY (id) );
我们可以通过以下命令将其转换为对应的 TypeScript 接口，并将表中的列名转换为帕斯卡式命名：
npx sql2ts --pascalCase users.sql
输出结果如下：
export interface Users {
Id: number;
FirstName?: string;
LastName?: string;
}同样，我们也可以选择将表中的列名转换为驼峰式命名：
npx sql2ts --camelCase users.sql
输出结果如下：
export interface Users {
id: number;
firstName?: string;
lastName?: string;
}--table
指定要转换的表名。
示例
假设我们有如下 SQL 文件 users.sql：
-- -------------------- ---- ------- ------ ----- -- --- ------ ----- - -- --- --- ---- --------------- ---- ------------ ----- ----------- --- ----- --- ---- ------- --- ---- -- ------ ----- -- --- ------ ------ - -- --- --- ---- --------------- ------- --- --- ----- ------- ----------- --- ----- -------- --- --- ----- ------- --- ----- ------- --- --------- ---------- --------- --
我们可以通过以下命令将其中的 users 表转换为对应的 TypeScript 接口：
npx sql2ts --table users users.sql
输出结果如下：
export interface Users {
id: number;
name?: string;
email: string;
age?: number;
}结语
sql2ts 是一款非常好用的 npm 包，可以极大地减少我们在编写前端项目时编写 TypeScript 数据结构的时间。希望这篇教程对大家有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600670a68ccae46eb111f207