@fluidframework/datastore 2.0.0-internal.7.0.0 → 2.0.0-internal.7.1.0
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.
- package/CHANGELOG.md +4 -0
- package/api-extractor.json +1 -1
- package/api-report/datastore.api.md +172 -0
- package/dist/dataStoreRuntime.d.ts +12 -0
- package/dist/dataStoreRuntime.d.ts.map +1 -1
- package/dist/dataStoreRuntime.js +9 -0
- package/dist/dataStoreRuntime.js.map +1 -1
- package/dist/datastore-alpha.d.ts +327 -0
- package/dist/datastore-beta.d.ts +327 -0
- package/dist/datastore-public.d.ts +327 -0
- package/dist/datastore.d.ts +326 -0
- package/dist/fluidHandle.d.ts +2 -0
- package/dist/fluidHandle.d.ts.map +1 -1
- package/dist/fluidHandle.js +2 -0
- package/dist/fluidHandle.js.map +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/dataStoreRuntime.d.ts +12 -0
- package/lib/dataStoreRuntime.d.ts.map +1 -1
- package/lib/dataStoreRuntime.js +9 -0
- package/lib/dataStoreRuntime.js.map +1 -1
- package/lib/fluidHandle.d.ts +2 -0
- package/lib/fluidHandle.d.ts.map +1 -1
- package/lib/fluidHandle.js +2 -0
- package/lib/fluidHandle.js.map +1 -1
- package/package.json +23 -28
- package/src/dataStoreRuntime.ts +12 -0
- package/src/fluidHandle.ts +2 -0
package/src/dataStoreRuntime.ts
CHANGED
|
@@ -81,12 +81,18 @@ import {
|
|
|
81
81
|
import { RemoteChannelContext } from "./remoteChannelContext";
|
|
82
82
|
import { FluidObjectHandle } from "./fluidHandle";
|
|
83
83
|
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
84
87
|
export enum DataStoreMessageType {
|
|
85
88
|
// Creates a new channel
|
|
86
89
|
Attach = "attach",
|
|
87
90
|
ChannelOp = "op",
|
|
88
91
|
}
|
|
89
92
|
|
|
93
|
+
/**
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
90
96
|
export interface ISharedObjectRegistry {
|
|
91
97
|
// TODO consider making this async. A consequence is that either the creation of a distributed data type
|
|
92
98
|
// is async or we need a new API to split the synchronous vs. asynchronous creation.
|
|
@@ -95,6 +101,8 @@ export interface ISharedObjectRegistry {
|
|
|
95
101
|
|
|
96
102
|
/**
|
|
97
103
|
* Base data store class
|
|
104
|
+
*
|
|
105
|
+
* @public
|
|
98
106
|
*/
|
|
99
107
|
export class FluidDataStoreRuntime
|
|
100
108
|
extends TypedEventEmitter<IFluidDataStoreRuntimeEvents>
|
|
@@ -1114,6 +1122,8 @@ export class FluidDataStoreRuntime
|
|
|
1114
1122
|
* Request handler is only called when data store can't resolve request, i.e. for custom requests.
|
|
1115
1123
|
* @param Base - base class, inherits from FluidDataStoreRuntime
|
|
1116
1124
|
* @param requestHandler - request handler to mix in
|
|
1125
|
+
*
|
|
1126
|
+
* @public
|
|
1117
1127
|
*/
|
|
1118
1128
|
export const mixinRequestHandler = (
|
|
1119
1129
|
requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>,
|
|
@@ -1134,6 +1144,8 @@ export const mixinRequestHandler = (
|
|
|
1134
1144
|
* @param handler - handler that returns info about blob to be added to summary.
|
|
1135
1145
|
* Or undefined not to add anything to summary.
|
|
1136
1146
|
* @param Base - base class, inherits from FluidDataStoreRuntime
|
|
1147
|
+
*
|
|
1148
|
+
* @public
|
|
1137
1149
|
*/
|
|
1138
1150
|
export const mixinSummaryHandler = (
|
|
1139
1151
|
handler: (
|
package/src/fluidHandle.ts
CHANGED
|
@@ -8,6 +8,8 @@ import { generateHandleContextPath } from "@fluidframework/runtime-utils";
|
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
10
|
* Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
|
|
11
|
+
*
|
|
12
|
+
* @public
|
|
11
13
|
*/
|
|
12
14
|
export class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
|
|
13
15
|
private readonly pendingHandlesToMakeVisible: Set<IFluidHandle> = new Set();
|