@fluidframework/tinylicious-客户端
微小的客户端软件包提供了一个简单而强大的方法,可以与微小的客户端服务一起消耗协作的流体数据.
使用 Fluid 框架库
对于依赖流体框架库的公共API,我们建议 ^ (caret)版本范围.
例如,使用 ^1.3.4。 。 。 .
依赖不稳定的API,例如: beta API,我们推荐一个更具限制性的版本范围.
例如,使用一个 ~ 版本范围.
安装
运行此命令以安装软件包 :
npm i @fluidframework/tinylicious-client
从此软件包导入
此软件包使用 packet.json 导出 通过支持级别将API分离. 有关支助保障的信息改为: API 支持级别。 。 。 .
导入 public API 从 @fluidframework/tinylicious-client。 。 。 .
导入 beta API 从 @fluidframework/tinylicious-client/beta。 。 。 .
API 文档
读取 @fluidframework/tinylicious-客户端 API 文档 https://fluidframework.com/docs/apis/tinylicious-客户端 互联网档案馆的存檔,存档日期2013-12-22。 。 。 .
使用微小客户
微小客户端包有默认值 TinyliciousClient 允许你与流体互动的课.
import { TinyliciousClient } from "@fluidframework/tinylicious-client";
证实微小的接近
Fluid需要支持服务,以便进行协作交流。 微小的客串公司 将会对微小的客串公司进行即时起诉.
下面的一个例子是,我们通过填写可选选项,在7070号港口上运行的小型服务在当地运行 port 参数在 TinyliciousConnectionConfig。 。 。 .
import { TinyliciousClient, TinyliciousConnectionConfig } from "@fluidframework/tinylicious-client";
const clientProps = { connection: { port: 7070 } };
const tinyliciousClient = new TinyliciousClient(clientProps);
流体容器
集装箱实例是流体内部的一个组织单位。 每个集装箱实例都与定义的流体服务连接,并包含一个独立的协作对象集合.
集装箱由独特的标识创建和识别。 这些想法的管理和存储是开发者的责任.
界定流体容器
流体容器由一个计划定义。 计划包括集装箱的初始特性以及能够动态生成哪些协作对象.
见 ContainerSchema 内 ./src/types/ts 关于具体属性的细节.
const schema = {
initialObjects: {
/* ... */
},
dynamicObjectTypes: [
/*...*/
],
};
const tinyliciousClient = new TinyliciousClient();
const { container, services } = await tinyliciousClient.createContainer(schema, "2.100.0" /* oldestSupportedClient */);
// Set any default data on the container's `initialObjects` before attaching
// Returned ID can be used to fetch the container via `getContainer` below
const id = await container.attach();
使用流体容器
使用默认 TinyliciousClient 对象,开发者可以创建和获取流体容器。 因为Fluid需要连接到服务器容器,需要同步创建和检索.
import { TinyliciousClient } from "@fluidframework/tinylicious-client";
const tinyliciousClient = new TinyliciousClient(props);
const { container, services } = await tinyliciousClient.getContainer("_unique-id_", schema, "2.100.0" /* oldestSupportedClient */);
使用初始对象
最常见的使用流体的方法是通过创建容器时创建的初始合作对象.
注:协作对象在流体内被称作可装入对象. 可装入对象是Fluid的特异性,并暴露出协作界面. 分布式数据结构与数据对象是可装入对象的类型.
initialObjects 集装箱装入内存,开发商可通过集装箱从集装箱上进入 initialObjects 属性。 这个 initialObjects 财产的签名与集装箱计划相同.
const schema = {
initialObjects: {
map1: SharedMap,
text1: SharedString,
},
};
const tinyliciousClient = new TinyliciousClient();
const { container, services } = await tinyliciousClient.getContainer("_unique-id_", schema, "2.100.0" /* oldestSupportedClient */);
const initialObjects = container.initialObjects;
const map1 = initialObjects.map1;
const text1 = initialObjects["text1"];
使用动态对象
可装入对象也可以在运行期间动态创建. 动态对象类型需要在 dynamicObjectTypes 集装箱计划的财产.
集装箱有一个 create 用于创建新类型实例的方法。 此实例会是用户的本地端, 直到附加到另一个可加载对象上 。 这样创建的动态对象应被存储在初始对象中,初始对象在创建容器时被附加. 当存储可加载对象时,您必须存储对象而非对象本身的引用 。 为了做到这一点,使用 handle 可加载对象上的属性.
动态对象按需要加载,以优化数据虚拟化. 要得到可装入对象,首先得到被存储的手柄再解决那个手柄.
const schema = {
initialObjects: {
map1: SharedMap,
},
dynamicObjectTypes: [SharedString],
};
const tinyliciousClient = new TinyliciousClient();
const { container, services } = await tinyliciousClient.getContainer("_unique-id_", schema, "2.100.0" /* oldestSupportedClient */);
const map1 = container.initialObjects.map1;
const newText = await container.create(SharedString);
map1.set("text-unique-id", newText.handle);
// ...
const textHandle = map1.get("text-unique-id"); // Get the handle
const text = await map1.get(); // Resolve the handle to get the object
// or
const text = await map1.get("text-unique-id").get();
客户最低要求
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.
要求提供文件未载列的资料, 创建问题。 。 。 .
商标
这个项目可能包含微软项目的商标或标志,产品,或服务.
这些商标或标志的使用必须遵循微软的 商标和品牌准则。 。 。 .
在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.