@fluidframework/core-interfaces 2.33.2 → 2.40.0-336023

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -246,7 +246,6 @@ export const IFluidLoadable: keyof IProvideFluidLoadable;
246
246
 
247
247
  // @public @sealed
248
248
  export interface IFluidLoadable extends IProvideFluidLoadable {
249
- // (undocumented)
250
249
  readonly handle: IFluidHandle;
251
250
  }
252
251
 
@@ -278,7 +278,6 @@ export const IFluidLoadable: keyof IProvideFluidLoadable;
278
278
 
279
279
  // @public @sealed
280
280
  export interface IFluidLoadable extends IProvideFluidLoadable {
281
- // (undocumented)
282
281
  readonly handle: IFluidHandle;
283
282
  }
284
283
 
@@ -246,7 +246,6 @@ export const IFluidLoadable: keyof IProvideFluidLoadable;
246
246
 
247
247
  // @public @sealed
248
248
  export interface IFluidLoadable extends IProvideFluidLoadable {
249
- // (undocumented)
250
249
  readonly handle: IFluidHandle;
251
250
  }
252
251
 
@@ -246,7 +246,6 @@ export const IFluidLoadable: keyof IProvideFluidLoadable;
246
246
 
247
247
  // @public @sealed
248
248
  export interface IFluidLoadable extends IProvideFluidLoadable {
249
- // (undocumented)
250
249
  readonly handle: IFluidHandle;
251
250
  }
252
251
 
@@ -14,10 +14,16 @@ export interface IProvideFluidLoadable {
14
14
  readonly IFluidLoadable: IFluidLoadable;
15
15
  }
16
16
  /**
17
- * A shared FluidObject has a URL from which it can be referenced
17
+ * A shared {@link FluidObject} with a handle that can be used to retrieve it.
18
+ * @remarks
19
+ * In this context, "shared" means that the object might be shared via a {@link https://fluidframework.com/docs/concepts/architecture#fluid-service|Fluid service} and
20
+ * thus could be viewed and edited by other clients.
18
21
  * @sealed @public
19
22
  */
20
23
  export interface IFluidLoadable extends IProvideFluidLoadable {
24
+ /**
25
+ * Handle to this loadable {@link FluidObject}.
26
+ */
21
27
  readonly handle: IFluidHandle;
22
28
  }
23
29
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"fluidLoadable.d.ts","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACxC;AACD;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAE5D,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACxC;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAG9B,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B"}
1
+ {"version":3,"file":"fluidLoadable.d.ts","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACxC;AACD;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACxC;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAG9B,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B"}
@@ -1 +1 @@
1
- {"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,cAAc,GAAgC,gBAAgB,CAAC;AAiB5E;;GAEG;AACU,QAAA,cAAc,GAAgC,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidHandle } from \"./handles.js\";\n\n/**\n * @public\n */\nexport const IFluidLoadable: keyof IProvideFluidLoadable = \"IFluidLoadable\";\n\n/**\n * @public\n */\nexport interface IProvideFluidLoadable {\n\treadonly IFluidLoadable: IFluidLoadable;\n}\n/**\n * A shared FluidObject has a URL from which it can be referenced\n * @sealed @public\n */\nexport interface IFluidLoadable extends IProvideFluidLoadable {\n\t// Handle to the loadable FluidObject\n\treadonly handle: IFluidHandle;\n}\n\n/**\n * @internal\n */\nexport const IFluidRunnable: keyof IProvideFluidRunnable = \"IFluidRunnable\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidRunnable {\n\treadonly IFluidRunnable: IFluidRunnable;\n}\n/**\n * @internal\n */\nexport interface IFluidRunnable {\n\t// TODO: Use `unknown` instead (API-Breaking)\n\n\trun(...args: any[]): Promise<void>;\n\tstop(reason?: string): void;\n}\n"]}
1
+ {"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,cAAc,GAAgC,gBAAgB,CAAC;AAsB5E;;GAEG;AACU,QAAA,cAAc,GAAgC,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidHandle } from \"./handles.js\";\n\n/**\n * @public\n */\nexport const IFluidLoadable: keyof IProvideFluidLoadable = \"IFluidLoadable\";\n\n/**\n * @public\n */\nexport interface IProvideFluidLoadable {\n\treadonly IFluidLoadable: IFluidLoadable;\n}\n/**\n * A shared {@link FluidObject} with a handle that can be used to retrieve it.\n * @remarks\n * In this context, \"shared\" means that the object might be shared via a {@link https://fluidframework.com/docs/concepts/architecture#fluid-service|Fluid service} and\n * thus could be viewed and edited by other clients.\n * @sealed @public\n */\nexport interface IFluidLoadable extends IProvideFluidLoadable {\n\t/**\n\t * Handle to this loadable {@link FluidObject}.\n\t */\n\treadonly handle: IFluidHandle;\n}\n\n/**\n * @internal\n */\nexport const IFluidRunnable: keyof IProvideFluidRunnable = \"IFluidRunnable\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidRunnable {\n\treadonly IFluidRunnable: IFluidRunnable;\n}\n/**\n * @internal\n */\nexport interface IFluidRunnable {\n\t// TODO: Use `unknown` instead (API-Breaking)\n\n\trun(...args: any[]): Promise<void>;\n\tstop(reason?: string): void;\n}\n"]}
@@ -14,10 +14,16 @@ export interface IProvideFluidLoadable {
14
14
  readonly IFluidLoadable: IFluidLoadable;
15
15
  }
16
16
  /**
17
- * A shared FluidObject has a URL from which it can be referenced
17
+ * A shared {@link FluidObject} with a handle that can be used to retrieve it.
18
+ * @remarks
19
+ * In this context, "shared" means that the object might be shared via a {@link https://fluidframework.com/docs/concepts/architecture#fluid-service|Fluid service} and
20
+ * thus could be viewed and edited by other clients.
18
21
  * @sealed @public
19
22
  */
20
23
  export interface IFluidLoadable extends IProvideFluidLoadable {
24
+ /**
25
+ * Handle to this loadable {@link FluidObject}.
26
+ */
21
27
  readonly handle: IFluidHandle;
22
28
  }
23
29
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"fluidLoadable.d.ts","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACxC;AACD;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAE5D,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACxC;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAG9B,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B"}
1
+ {"version":3,"file":"fluidLoadable.d.ts","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACxC;AACD;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACxC;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAG9B,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B"}
@@ -1 +1 @@
1
- {"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAgC,gBAAgB,CAAC;AAiB5E;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAgC,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidHandle } from \"./handles.js\";\n\n/**\n * @public\n */\nexport const IFluidLoadable: keyof IProvideFluidLoadable = \"IFluidLoadable\";\n\n/**\n * @public\n */\nexport interface IProvideFluidLoadable {\n\treadonly IFluidLoadable: IFluidLoadable;\n}\n/**\n * A shared FluidObject has a URL from which it can be referenced\n * @sealed @public\n */\nexport interface IFluidLoadable extends IProvideFluidLoadable {\n\t// Handle to the loadable FluidObject\n\treadonly handle: IFluidHandle;\n}\n\n/**\n * @internal\n */\nexport const IFluidRunnable: keyof IProvideFluidRunnable = \"IFluidRunnable\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidRunnable {\n\treadonly IFluidRunnable: IFluidRunnable;\n}\n/**\n * @internal\n */\nexport interface IFluidRunnable {\n\t// TODO: Use `unknown` instead (API-Breaking)\n\n\trun(...args: any[]): Promise<void>;\n\tstop(reason?: string): void;\n}\n"]}
1
+ {"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAgC,gBAAgB,CAAC;AAsB5E;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAgC,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidHandle } from \"./handles.js\";\n\n/**\n * @public\n */\nexport const IFluidLoadable: keyof IProvideFluidLoadable = \"IFluidLoadable\";\n\n/**\n * @public\n */\nexport interface IProvideFluidLoadable {\n\treadonly IFluidLoadable: IFluidLoadable;\n}\n/**\n * A shared {@link FluidObject} with a handle that can be used to retrieve it.\n * @remarks\n * In this context, \"shared\" means that the object might be shared via a {@link https://fluidframework.com/docs/concepts/architecture#fluid-service|Fluid service} and\n * thus could be viewed and edited by other clients.\n * @sealed @public\n */\nexport interface IFluidLoadable extends IProvideFluidLoadable {\n\t/**\n\t * Handle to this loadable {@link FluidObject}.\n\t */\n\treadonly handle: IFluidHandle;\n}\n\n/**\n * @internal\n */\nexport const IFluidRunnable: keyof IProvideFluidRunnable = \"IFluidRunnable\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidRunnable {\n\treadonly IFluidRunnable: IFluidRunnable;\n}\n/**\n * @internal\n */\nexport interface IFluidRunnable {\n\t// TODO: Use `unknown` instead (API-Breaking)\n\n\trun(...args: any[]): Promise<void>;\n\tstop(reason?: string): void;\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/core-interfaces",
3
- "version": "2.33.2",
3
+ "version": "2.40.0-336023",
4
4
  "description": "Fluid object interfaces",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -17,11 +17,16 @@ export interface IProvideFluidLoadable {
17
17
  readonly IFluidLoadable: IFluidLoadable;
18
18
  }
19
19
  /**
20
- * A shared FluidObject has a URL from which it can be referenced
20
+ * A shared {@link FluidObject} with a handle that can be used to retrieve it.
21
+ * @remarks
22
+ * In this context, "shared" means that the object might be shared via a {@link https://fluidframework.com/docs/concepts/architecture#fluid-service|Fluid service} and
23
+ * thus could be viewed and edited by other clients.
21
24
  * @sealed @public
22
25
  */
23
26
  export interface IFluidLoadable extends IProvideFluidLoadable {
24
- // Handle to the loadable FluidObject
27
+ /**
28
+ * Handle to this loadable {@link FluidObject}.
29
+ */
25
30
  readonly handle: IFluidHandle;
26
31
  }
27
32