@codaco/protocol-utilities

中文文档
5.0.0发布于 2026/10/13MITTypeScriptES Module构建来源已验证近 30 天下载 3484

网络Canvas协议的合成网络生成和访谈-负载构建器.

中文使用文档
文档目录4 节
  1. 出口
  2. 家庭出身
  3. 拒绝的协议
  4. 消费者

@codaco/ protocol- 用途

网络Canvas协议的合成网络生成和访谈-负载构建器.

出口

  • generateNetwork(params) 纯函数产生 NcNetwork (加上阶段元和步骤状态)用于给定协议. 单曲 GenerateNetworkParams 对象 : codebook 财务报告和审定财务报表 stages 需要; externalData, (中文(简体) ), seed, (中文(简体) ), simulateDropOut, (中文(简体) ), respectSkipLogicAndFiltering, (中文(简体) ), inProgressStageIndex, (中文(简体) ), config,以及 familyPedigree 是可选的。 回返a GenerateNetworkResult。 。 。 .
  • GenerateNetworkParams, (中文(简体) ), GenerateNetworkResult ——参数和结果类型.
  • GenerationConfig ——调和常数(节点计数,边缘概率,退出因子,以及日期相接的相对日期等). params.config 使用一个 Partial 说吧.
  • SyntheticDataConstraintError, (中文(简体) ), ConstraintConflict - 拒绝 generateNetwork 抛出,和它所携带的形状。 见下文.
  • SyntheticInterview ——能构建代码簿,相位,提示,形式和全面接有效载荷的流利建造者.

两者共用 a ValueGenerator (单位:千美元)@faker-js/faker 包装)用于确定值合成:通过 a seed 用于可复制输出.

家庭出身

FamilyPedigree阶段使用孤立的人口生成器,而不是通用的节点和尖端相接器. 捆绑起来 US_FAMILY_PEDIGREE_POPULATION 从2017-2019年全国家庭成长调查中得出了完整的家庭规模,然后对联系人的兄弟姐妹和父母的兄弟姐妹群体使用有尺寸偏见的画作。 它包括源的URL,因此呼叫者可以审计假设或替换另一个研究群的剖面.

过 familyPedigree 定制人口、盖子可选分支、使所种植的疾病种类丧失能力,或强迫收养、捐赠者-受孕或代孕情况进行检测。 人口模式以配置的速率对这些情况进行抽样。 家庭地貌学和属性使用一个阶段特定的定型随机流,因此改变一个pedigree不会移动其他面试阶段使用的随机流.

拒绝的协议

生成的值满足一个协议在其变量上声明的验证规则,所以一个合成网络只持有参与者可以输入的数据. 如果协议的规则不能一举实现, generateNetwork 掷出 SyntheticDataConstraintError 而不是透露数据 采访会拒绝.

多数拒绝都是在划出任何东西之前决定的,仅从宣布的界限,所以不依赖于种子. 其余部分是在绘图时提出的,当一个变量与那些变量相比价值耗尽时,它的规则将其与这些变量联系在一起.

错误 conflicts 数组带一个 ConstraintConflict 每个问题,每个问题都命名实体(entity附加时 entityType 财务报告和审定财务报表 entityTypeName 用于节点和边缘 variableIds 财务报告和审定财务报表 variableNames 参与 rules (a) 与《公约》有关的其他事项 reason。消费者可以直接制作这些产品;错误在于 message 是文本的相同信息.

消费者

  • apps/architect —— 说 generateNetwork 包含协议预览 .
  • apps/interviewer —— 说 generateNetwork 背面合成访谈生成.
  • @codaco/interview —— 说 SyntheticInterview 建立故事书和E2E固定装置。 唯德消费.
  • Fresco——外国消费者 generateNetwork。 。 。 .

版本与发布记录

@codaco/protocol-utilities 共发布 17 个版本,首次发布于 2026/05/21;过去 12 个月发布了 17 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.0.0latest2026/10/1327 天前
4.1.02026/09/291 个月前
4.0.02026/08/312 个月前
3.2.12026/08/112 个月前
3.2.02026/08/063 个月前
3.1.12026/08/053 个月前

其他发布通道:alpha → 1.0.0-alpha.0。

关于 @codaco/protocol-utilities 的常见问题

@codaco/protocol-utilities 是什么?

网络Canvas协议的合成网络生成和访谈-负载构建器.

如何安装 @codaco/protocol-utilities?

在项目目录运行 npm install @codaco/protocol-utilities,或使用 pnpm add / yarn add / bun add。

@codaco/protocol-utilities 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@codaco/protocol-utilities 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@codaco/protocol-utilities 可以商用吗?

@codaco/protocol-utilities 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@codaco/protocol-utilities 的下载量有多少?

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

@codaco/protocol-utilities 还在维护吗?

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