@cloudflare/json-schema-walker

中文文档
0.1.1发布于 2018/04/21BSD-3-ClauseCommonJS零依赖近 30 天下载 27.7万

"走JSON Schemas和对他们采取行动的便利"

中文使用文档
文档目录3 节
  1. 行者们
  2. 回电
  3. 词汇

杰森·斯克马·沃克

一个访问 JSON Schema 文件中所有计划对象的系统 ,并在访问所有当前之前和(或)之后重新调用 schemaobject's subschemas. 中国植物物种信息数据库.

目前,有许多词汇需要选择,必须 用于两个行走功能。 作为 词汇概念 在JSON Schema定稿 草案08,此软件包将被重新修改以直接支持它.

行者们

两个行走者接受一个或两个回调功能,但不同 稍微在他们的行为。 在这两种情况下,都有"路径" 或“ parentPath” 概念是 JSON 属性的数组 名称或数组索引随即到达当前计划.

请注意,行走者召回会修改 计划结构 到位,所以如果需要的话,复制一份副本 原始的也一样.

schemaWalk(schema, preFunc, postFunc, vocabulary)

这只叫前Func召回(如果有的话), 电话 subschemaWalk 空父路径 [],以及 然后调用后Func召回.

subschemaWalk(scheam, preFunc, postFunc, parentPath, vocabulary)

有时从文件的某个地方开始是有用的, 哪个 subschemaWalk 通过走父路径完成 . 连接电话也是这样开始的 行走 - 计算每个后续呼叫的母路径 散步时.

特别是,以不同方式处理根子方案很常见, 所以打电话 subschemaWalk 以空取为底端的尖端 父路径 [] 允许跳过根图.

回电

无论是 preFunc 或者说 postFunc 电话可以是无效的,也可以是两个都可以通过同一行走. 他们预计将采取以下行动: 作为位置参数 :

  1. 正在处理的 schema 对象( 或布尔)
  2. 其父子计划路径
  3. 父方案对象( 如果有)
  4. 从 schema 文档根到父端的路径

路径是类似于 JSON 指针。考虑到 ["foo", 42] 作为从根到母对象的路径,以及 ["bar"] 作为从母对象到正在处理的计划的路径,等同 贾森 指针碎片 对于父母来说 "#/foo/42而对于正在处理的计划来说 #/foo/42/bar。 。 。 .

同等数额 相对 JSON 指针 从父母到正在处理的计划 0/bar。 。 。 .

空路径作为空数组表示 []。对于根部的指针,这相当于 # 作为JSON指针碎片.

对于从母体到正在处理的策略的空路径(意味着两者是相同的,这发生在根策略上),这相当于 0 作为相对的JSON指针.

词汇

getVocabulary(schema, defaultVocabulary) 这返回基于 schema 的行走者词汇对象 $schema 关键字,或返回默认值,如果 $schema 不存在或不承认。 如果没有提供当前默认值 JSON超计划草案。 。 。 .

一旦以一个正式的"计划词汇"概念来发表草稿-08,这个套件的词汇执行可能会被大幅度地重修.

版本与发布记录

@cloudflare/json-schema-walker 共发布 1 个版本,首次发布于 2018/04/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.1latest2018/04/218 年前

关于 @cloudflare/json-schema-walker 的常见问题

@cloudflare/json-schema-walker 是什么?

"走JSON Schemas和对他们采取行动的便利"

如何安装 @cloudflare/json-schema-walker?

在项目目录运行 npm install @cloudflare/json-schema-walker,或使用 pnpm add / yarn add / bun add。

@cloudflare/json-schema-walker 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/cloudflare__json-schema-walker 是否存在。

@cloudflare/json-schema-walker 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@cloudflare/json-schema-walker 可以商用吗?

@cloudflare/json-schema-walker 使用 BSD-3-Clause 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括,不构成法律意见,请以许可原文为准。

@cloudflare/json-schema-walker 的下载量有多少?

根据 npm 官方下载统计,@cloudflare/json-schema-walker 在 2026/10/10 – 2026/11/08 这 30 天内被下载 276,985 次,日均约 9,233 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cloudflare/json-schema-walker 还在维护吗?

最新版本 0.1.1 发布于 2018/04/21(8 年前);至今共发布 1 个版本,其中过去 12 个月发布了 0 个;首次发布于 2018/04/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。