什么是 @types/z-schema?
@types/z-schema是一个TypeScript类型定义文件的npm包。它提供了 TypeScript 的类型定义和完整的 JavaScript 库，用于在运行时验证 JSON 对象是否符合特定的 JSON schema。
安装和使用 @types/z-schema
首先，在安装和使用@types/z-schema之前，我们需要在项目中安装z-schema。我们可以使用 npm 直接安装它：
npm install z-schema
然后，我们需要为 TypeScript 安装@types/z-schema，以便获得 TypeScript 的类型定义：
npm install --save-dev @types/z-schema
一旦我们已经安装了@types/z-schema，我们就可以在 TypeScript 代码中使用导入语句来导入它：
import ZSchema from "z-schema";
然后我们可以创建一个新的ZSchema实例来验证 JSON 对象是否符合特定的 JSON schema：
-- -------------------- ---- -------
----- --------- - --- ----------
----- ------ - -
------- ---------
------------- -
------- -
------- --------
--
------ -
------- --------
-
--
----------- -------- ------
--
----- ---- - -
------- -------
------ --
--
----- ----- - ------------------------ --------
------------------- -- ----在上面的代码中，我们创建了一个新的ZSchema实例，并使用它来验证一个JSON对象。我们还了一个名为schema的JSON schema。最后，我们使用验证器的validate方法来验证JSON对象是否符合指定的schema。如果对象有效，则返回true，否则返回false。
参数和选项
在上面的示例中，我们只传递了schema和data参数。但是，ZSchema有很多可配置的选项，我们可以使用它们来控制验证器的行为。以下是一些最常用的选项：
- noExtraKeywords：当设置为true时，ZSchema将不允许未在schema中定义的任何其他关键字。
- ignoreUnknownFormats：当设置为true时，ZSchema将不会验证未知格式的字符串（例如，它将不会检查URL格式是否正确）。
- breakOnFirstError：当设置为true时，ZSchema将在第一个错误处中断验证，并立即返回false。
- ignoreUnresolvableReferences：当设置为true时，ZSchema将不会验证无法解析的引用。
我们可以在创建ZSchema实例时传递选项的对象：
const validator = new ZSchema({
noExtraKeywords: true,
ignoreUnknownFormats: true,
breakOnFirstError: true,
ignoreUnresolvableReferences: true
});深层嵌套
如果我们有一个深度嵌套的JSON对象，我们可以使用$ref关键字来引用其他schema。下面是一个例子：
-- -------------------- ---- -------
----- ------------- - -
------- ---------
------------- -
------- -------- ----------
-------- -------- ---------
--
----------- -------- --------
--
----- -------------- - -
------- ---------
------------- -
-------- -
------- ---------
------------- -
------- -------- ----------
----------- -
------- --------
-------- -
------- -----------------
-
-
--
----------- -------- -----------
-
--
----------- ---------
--
----- ---- - -
-------- -
------- --- -------
----------- -
-------- -------- --- -------- ------
-------- -------- --- -------- ------
-
-
--
------------------------ ----------------在上面的示例中，我们定义了两个不同的JSON schema：一个用于产品对象（productSchema），另一个用于嵌套的数据结构（productsSchema）。productsSchema包含一个引用了productSchema的数组。我们可以通过将$ref的值设置为其定义的schema的名称（在这种情况下为productSchema）来实现。
总结
@types/z-schema是一个非常有用的TypeScript类型定义文件的npm包。使用它，我们可以验证JSON对象是否与特定的JSON schema相匹配。通过定义我们的schema，我们可以控制验证器的行为和结构，以满足我们的特定需求。如果您正在寻找一种易于使用，可扩展的JSON验证方案，请考虑使用@types/z-schema。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/types-schema