@ fluidframework/core-utils (英语)

这一一揽子计划旨在分享和促进 " 流体不可知 " 公用事业职能的最佳做法 在“流体框架 repo”中跨包.

使用 Fluid 框架库

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

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

安装

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

npm i @fluidframework/core-utils

从此软件包导入

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

导入 public API 从 @fluidframework/core-utils。 。 。 .

导入 beta API 从 @fluidframework/core-utils/beta。 。 。 .

导入 alpha API 从 @fluidframework/core-utils/alpha。 。 。 .

导入 legacy API 从 @fluidframework/core-utils/legacy。 。 。 .

API 文档

读取 @ fluidframework/core-utils (英语) API 文档 https://fluidframework.com/docs/apis/core-utils (中文(简体) )。 。 。 .

在此软件包中添加代码

作为一个通用软件包,这个软件包没有很强的特性. 也就是说很容易变成"被倾销" 我们觉得应该共享的代码 但没有明显的家 我们尽量避免把东西丢进 工具包, 这个也不例外 .

新的代码只应在罕见的情况下添加到这个包中. 在大多数情况下,编码最好放在 具有明确身份的软件包(如共享事件基础设施的"事件"软件包)或完全不共享.

所需资源

这个包对里面的代码有重要要求.

1. 本套件中的代码必须具有零依赖性. 也就是说,它不能依赖其他一揽子方案,即使在 流体框架还原. devDependencies 没事.
2. 所有出口必须指定 @internal。 。 。 . 此代码仅用于流体框架中.
3. 这个包应该 只包含"执行"代码,而不是类型定义. 这是最灵活的规则,和 有一些例外。 如果类型是 仅限 当使用此软件包时, 可能还有必要。 不过, 这类类型通常最好放在核心界面或符合目的的包中.

如果您想要添加不符合这些要求的代码,这些其他软件包可能是一个更好的选择:

• 类型和接口 应把打算广泛共享的客户发布组放入 核心接口 软件包.
• 具有依赖关系的共享执行代码 应放入 客户端功能 软件包.

客户最低要求

Fluid框架客户端库支持此文档中的平台. 这些要求有意具有限制性. 在一个主要的版本系列中,我们可以放松这些要求,但我们不能使其更严格. 对于长期支持(LTS)版本,我们可能需要支持这些平台几年.

其他配置可以奏效,但Fluid框架不支持. 如果一个不支持的配置停止工作, 我们不会将此归类为错误 . 要请求支持未列出的配置, 请存档 . 产品组会评估你的要求. 在此问题上,请具体说明配置的现状:

• 配置有效但需要官方支持.
• 配置不起作用,需要更改.

支持的运行时间

• Fluid框架支持节点.js版本22和24同时收到 上游支助。 。 。 .
  • 流体框架将停止支持第22版 当上游支持于2027-04-30结束时。 。 。 .
  • 流体框架不支持节点.js与 --no-experimental-fetch 旗帜.
• Fluid框架支持支持ES2022标准库的现代浏览器.

支持的工具

• 类型脚本 6.0数字 :
  • 流体框架支持全部 strict 选项.
  • 设定建设目标(lib, (中文(简体) ), target改为: ES2022 或后会.
  • 启用 strictNullChecks。 。 。 .
  • 流体框架不支持 在 TypeScript 6.0 中贬值的配置选项。 。 。 .
  • 流体框架不完全支持 exactOptionalPropertyTypes。 。 。 . 如果您启用此选项, 请不要使用 in, (中文(简体) ), Reflect.has, (中文(简体) ), Object.hasOwn,或 Object.prototype.hasOwnProperty 改为Fluid框架类型的窄成员. 这些方法可以错误地排除 undefined 从可能的值.
• 网络软件包 页:1
  • 我们不需要一个特定的捆绑者. 其他处理ES模块的捆绑机可以工作,但我们只积极测试网页包.

模块分辨率

在类型脚本中 compilerOptions,使用时 Node16, (中文(简体) ), Node20, (中文(简体) ), NodeNext,或 Bundler 模块分辨率. 这些设置遵循 节点.js v12+无害环境管理 分辨率和加载算法。 。 。 .

不使用 Node10 模块分辨率.

模块格式

• ES模块: 使用ES模块来消耗Fluid框架客户端软件包,包括在Node.js中.
• 常见JS : Fluid Framework在3.0版本或后期不正式支持CommonJS.

贡献准则

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

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

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

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

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

帮助

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

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

商标

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

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

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