前言
在前端开发中，数据类型的验证往往是必不可少的。而 TypeScript 的强类型系统在很大程度上可以帮助我们规避类型相关的错误。但即使使用 TypeScript，我们也需要一些工具去验证数据类型是否匹配。ts-interface-checker 是一个可以帮助我们验证 TypeScript 接口（Interface）和类型（Type）的 npm 包，可以方便地在 TypeScript 中进行数据类型验证。
安装
首先，我们需要在项目中安装 ts-interface-checker。
npm install ts-interface-checker --save
创建 Interface
在使用 ts-interface-checker 进行数据类型验证前，需要创建 TypeScript 接口或类型来表示需要验证的数据结构。以下是一个例子：
-- -------------------- ---- -------
--------- ---- -
----- -------
---- -------
------ -------
--------- -
----- -------
-------- -------
-
-以上代码定义了一个名为 User 的 Interface ，该 Interface 表示 User 对象的结构：包含名称、年龄和电子邮件地址，并且可以选择性地包含地址信息。我们将使用 ts-interface-checker 来验证 User 对象是否符合此结构。
创建验证对象
ts-interface-checker 的核心是 Validator 类，该类可以被用来在运行时验证对象是否符合 TypeScript 接口或类型定义。要使用 Validator 类，必须首先创建一个 Validator 对象，并传递要验证的 Interface 和 Type。
import { Validator } from "ts-interface-checker";
const validateUser = new Validator<User>({});上例中，我们创建了一个名为 validateUser 的 Validator 对象，将 User 接口传递给它以验证对象结构。这时候 validateUser 对象还没有校验规则。
添加校验规则
接下来，需要将校验规则添加到 Validator 对象中。规则是通过调用对象的 .rule() 方法来添加的。以下是一个例子：
-- -------------------- ---- -------
----- ------------ - --- -----------------
----- - ----- -------- --
---- - ----- --------- -------- -- --
------ - ----- --------- ------- ------- --
-------- -
----- ---------
--------- -----
----------- -
----- - ----- -------- --
-------- - ----- -------- -
-
-
---此例中，我们向 Validator 对象添加了多个规则。对于 User 对象中的每个属性，我们都指定了验证规则。规则是以对象的形式指定的，其中必须提供至少一个 type 属性。在上例中，我们对名称、年龄、电子邮件和地址都进行了验证，使用的类型限制分别是 string、number、string 和可选的 address 对象，该 address 对象必须拥有 city 和 country 属性。age 属性还设置了最小值为 18。
执行验证
一旦添加校验规则，就可以使用 Validator 对象的 .validate() 方法来验证一个对象的结构是否符合指定的要求。
-- -------------------- ---- -------
----- ---- - -
----- -------
---- ---
------ -----------------------
--
----- ------ - ----------------------------
-- --------------- -
----------------------------
-此处我们使用了 validateUser 的 .validate() 方法来验证一个用户对象是否符合 User 接口的定义。该方法将返回一个 ValidationResult 对象，其包含一个名为 valid 的布尔值指示对象是否验证通过，以及一个可选的 error 对象，它包含验证失败的详细信息。
如果对象验证失败，我们可以使用 result.error 属性来检查错误信息。
示例代码
以下是一个完整的示例代码，可以在 Node.js 或浏览器中直接运行。
-- -------------------- ---- -------
------ - --------- - ---- -----------------------
--------- ---- -
----- -------
---- -------
------ -------
--------- -
----- -------
-------- -------
-
-
----- ------------ - --- -----------------
----- - ----- -------- --
---- - ----- --------- -------- -- --
------ - ----- --------- ------- ------- --
-------- -
----- ---------
--------- -----
----------- -
----- - ----- -------- --
-------- - ----- -------- -
-
-
---
----- --------- - -
----- -------
---- ---
------ ------------------------
-------- -
----- ---- ------
-------- -----
-
--
----- ----------- - -
----- -------
---- ---
------ -------------
--
------------------ ----- -- ----------------------------------
-------------------- ----- -- ------------------------------------在上述代码中，我们定义了一个 User 接口，并创建了一个 Validator 对象 validateUser，用于验证这个用户对象符合我们需要的数据结构。接着，我们定义了两个用户对象：validUser 和 invalidUser，分别用于测试符合和不符合接口的验证。最后，我们执行了 .validate() 方法，将这两个用户对象分别传递给 validateUser 对象进行验证，并输出结果。
总结
ts-interface-checker 可以帮助我们在运行时校验 TypeScript 接口或类型定义的对象，确保对象的结构与我们的预期相符。使用 Validator 对象，我们可以指定校验规则，然后对对象进行验证，并查看结果，以确保程序的正确性和可靠性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/202634