@ fluidframework/地图
使用 Fluid 框架库
对于依赖流体框架库的公共API,我们建议 ^ (caret)版本范围.
例如,使用 ^1.3.4。 。 。 .
依赖不稳定的API,例如: beta API,我们推荐一个更具限制性的版本范围.
例如,使用一个 ~ 版本范围.
安装
运行此命令以安装软件包 :
npm i @fluidframework/map
从此软件包导入
此软件包使用 packet.json 导出 通过支持级别将API分离. 有关支助保障的信息改为: API 支持级别。 。 。 .
导入 public API 从 @fluidframework/map。 。 。 .
导入 legacy API 从 @fluidframework/map/legacy。 。 。 .
API 文档
读取 @ fluidframework/地图 API 文档 https://fluidframework.com/docs/apis/map 页面存档备份,存于互联网档案馆。 。 。 .
共享地图
共享映射分布式数据结构可用于存储密钥值对. 它为设置和提供相同的API 获取 JavaScript 开发者习惯的值 地图 内建对象.
创建
创建 SharedMap,调用静态创建方法:
const myMap = SharedMap.create(this.runtime, id);
使用量
不同于 Java 脚本 Map页:1 SharedMap密钥必须是字符串 。 值只必须是普通JS对象或手柄(例如对另一个DS或流体对象).
在协作情况下,通过下列政策解决价值: 最后写取胜。 。 。 .
事件
SharedMap 是一个 EventEmitter,并将在其他客户端进行修改时释放出事件。 您应该为这些事件注册,并在修改数据时作出适当反应. valueChanged 将针对 set 或者说 delete,并提供存储在该密钥上的密钥和先前值. clear 将针对 clear。 。 。 .
共同导演与导演
A 类 SharedDirectory 是一种类似于地图的DDS,它额外支持在子目录树内存储密钥/值对. 这个子目录树可以用来给存储的密钥/值对提供分级结构,而不是将其存储在平面图上. 两者 SharedDirectory 任何子目录都是 IDirectories。 。 。 .
创建
创建 SharedDirectory,调用静态创建方法:
const myDirectory = SharedDirectory.create(this.runtime, id);
使用量
地图操作 IDirectory 指存储在其中的密钥/值对 IDirectory,功能就像 SharedMap 包括相同的额外功能以及对密钥和值的限制。 要操作子目录结构,采用相应的子目录方法.
getWorkingDirectory()
为"引出"子目录结构, IDirectory 页:1 getWorkingDirectory 返回 IDirectory 如果路径存在,则位于该路径.
事件
valueChanged 事件还提供了存储所改变的值的子目录的绝对路径.
dispose 事件在被删除的子目录上开火。 此子目录的任何访问都会在被处理后丢出一个错误 .
客户最低要求
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.
贡献准则
你们可以 贡献 通过这些方式实现流体框架:
详细指示改为: repo 文档。 。 。 .
本项目遵循 Microsoft 开源行为守则。 。 。 . 更多信息,改为: 《行为守则》经常被问到的问题。 。 。 . 问题或评论,联系 打开码@ microsoft.com。 。 。 .
这个项目可能包含微软项目的商标或标志,产品,或服务. 这些商标或标志的使用必须遵循微软 商标和品牌准则。 。 。 . 在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.
帮助
读取 流体框架文件 用于了解流体框架概念和API.
要求提供文件未载列的资料, 创建问题。 。 。 .
商标
这个项目可能包含微软项目的商标或标志,产品,或服务.
这些商标或标志的使用必须遵循微软的 商标和品牌准则。 。 。 .
在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.