@ fluidframework/ fluid-runner (英语)

此软件包包含用于在流体框架环境中运行各种功能的功能 .

使用 Fluid 框架库

对于依赖流体框架库的公共API,我们建议 ^ (caret)版本范围. 例如,使用 ^1.3.4。 。 。 .

依赖不稳定的API,例如: beta API,我们推荐一个更具限制性的版本范围. 例如,使用一个 ~ 版本范围.

安装

运行此命令以安装软件包 :

npm i @fluidframework/fluid-runner

从此软件包导入

此软件包使用 packet.json 导出 通过支持级别将API分离. 有关支助保障的信息改为: API 支持级别。 。 。 .

导入 public API 从 @fluidframework/fluid-runner。 。 。 .

导入 legacy API 从 @fluidframework/fluid-runner/legacy。 。 。 .

导出文件

允许在给定的 ODSP 快照的容器上执行一些执行 .

样本命令

如果在全球安装软件包 : node fluid-runner exportFile --codeLoader=compiledBundle.js --inputFile=inputFileName.fluid --outputFile=result.txt --telemetryFile=telemetryFile.txt

如果直接使用此软件包 : node bin/fluid-runner exportFile --codeLoader=compiledBundle.js --inputFile=inputFileName.fluid --outputFile=result.txt --telemetryFile=telemetryFile.txt

代码装入器捆绑格式

编码装入器捆绑应规定这一功能所需的有定义的出口. 关于需要出口的更详细情况,见: 代码LoaderBundle.ts。 。 。 .

"code Loader" vs "IFluid File Converter" 参数

您可能注意到命令行参数 codeLoader 是可选的。 如果您选择不为 codeLoader,您必须扩展此库 并提供一个 IFluidFileConverter 联合国 fluidRunner(...) 方法.

import { fluidRunner } from "@fluidframework/fluid-runner";

await fluidRunner({
    /* IFluidFileConverter implementation here */
});

说明: 只有一个 codeLoader 或者说 fluidRunner(...) 允许参数。 如果两者均提供或无提供,则在执行开始时会出现出错.

输入文件格式

输入文件预计将是ODSP快照. 关于一些实例,请参见 本地 OdspSnapshot 文件夹。 。 。 .

遥测格式

有一个可选的命令行选项 telemetryFormat 它允许您指定遥测输出格式。 此选项的命名很严格,必须匹配其中的选项 输出格式。 。 。 . 默认格式是当前 JSON

额外的遥测属性

有一个可选的命令行选项 telemetryProp 它允许您指定每个远程测量条目中将添加的额外属性。 格式遵循这些规则:

• 每个密钥必须是字符串
• 值可以是字符串或数字
• 密钥和值不能为空

有效用法实例:

--telemetryProp prop1 value1 --telemetryProp prop2 10.5
--telemetryProp "  prop1 " "   value1 " prop2 value2
--telemetryProp prop1 "aaa=bbb" prop2 "aaa\"bbb"

引文中不修饰白- 空格

无效用法示例 :

--telemetryProp "10" value1
--telemetryProp prop1
--telemetryProp=             // this will be treated as ['']

消费

代码周围 exportFile 可以在多个不同的层被消耗. 无需像现在这样完全运行所有这些代码,以下是本工作流程中涉及的一些有趣的代码比特:

• createLogger(...)
  • 创建并包 IFileLogger 并在每个条目中添加一些有用的遥测数据
• createContainerAndExecute(...)
  • 这是基于本地 ODSP 快照运行一些动作的核心逻辑
• getSnapshotFileContent(...)
  • 从 JSON 和 二进制格式读取本地 ODSP 快照, 用于 createContainerAndExecute(...)

举例来说,消费途径略有不同: exportFile(...),参见 parseBundleAndExportFile(...)。除了运行与 exportFile 方法,它执行围绕解析动态提供的捆绑路径的逻辑 IFluidFileConverter 对象.

贡献准则

你们可以 贡献 通过这些方式实现流体框架:

• 回答问题 GitHub 讨论。 。 。 .
• 提交错误报告 并且帮助验证修正.
• 审查 源代码更改。 。 。 .
• 贡献错误修正。 。 。 .

详细指示改为: repo 文档。 。 。 .

本项目遵循 Microsoft 开源行为守则。 。 。 . 更多信息,改为: 《行为守则》经常被问到的问题。 。 。 . 问题或评论,联系 打开码@ microsoft.com。 。 。 .

这个项目可能包含微软项目的商标或标志,产品,或服务. 这些商标或标志的使用必须遵循微软 商标和品牌准则。 。 。 . 在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.

帮助

读取 流体框架文件 用于了解流体框架概念和API.

要求提供文件未载列的资料, 创建问题。 。 。 .

商标

这个项目可能包含微软项目的商标或标志,产品,或服务.

这些商标或标志的使用必须遵循微软的 商标和品牌准则。 。 。 .

在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.