fluid-framework 2.0.0-dev-rc.5.0.0.267932 → 2.0.0-dev-rc.5.0.0.268409
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/api-report/{fluid-framework.api.md → fluid-framework.alpha.api.md} +13 -22
- package/api-report/fluid-framework.beta.api.md +642 -0
- package/api-report/fluid-framework.public.api.md +642 -0
- package/dist/legacy.d.ts +0 -2
- package/dist/public.d.ts +0 -2
- package/lib/legacy.d.ts +0 -2
- package/lib/public.d.ts +0 -2
- package/package.json +11 -11
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## API Report File for "fluid-framework"
|
|
1
|
+
## Alpha API Report File for "fluid-framework"
|
|
2
2
|
|
|
3
3
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
4
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
import { Client } from '@fluidframework/merge-tree/internal';
|
|
8
8
|
import { ErasedType } from '@fluidframework/core-interfaces';
|
|
9
9
|
import { IChannel } from '@fluidframework/datastore-definitions/internal';
|
|
10
|
-
import
|
|
10
|
+
import { IDisposable } from '@fluidframework/core-interfaces';
|
|
11
11
|
import type { IErrorBase } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IErrorEvent } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
@@ -105,9 +105,6 @@ export interface DefaultProvider extends ErasedType<"@fluidframework/tree.FieldP
|
|
|
105
105
|
// @alpha (undocumented)
|
|
106
106
|
export type DeserializeCallback = (properties: PropertySet) => void;
|
|
107
107
|
|
|
108
|
-
// @public
|
|
109
|
-
export const disposeSymbol: unique symbol;
|
|
110
|
-
|
|
111
108
|
// @public
|
|
112
109
|
export type ExtractItemType<Item extends LazyItem> = Item extends () => infer Result ? Result : Item;
|
|
113
110
|
|
|
@@ -163,7 +160,7 @@ export interface IConnection {
|
|
|
163
160
|
export type ICriticalContainerError = IErrorBase;
|
|
164
161
|
|
|
165
162
|
// @alpha
|
|
166
|
-
export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<
|
|
163
|
+
export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {
|
|
167
164
|
readonly absolutePath: string;
|
|
168
165
|
countSubDirectory?(): number;
|
|
169
166
|
createSubDirectory(subdirName: string): IDirectory;
|
|
@@ -190,11 +187,6 @@ export interface IDirectoryValueChanged extends IValueChanged {
|
|
|
190
187
|
path: string;
|
|
191
188
|
}
|
|
192
189
|
|
|
193
|
-
// @public
|
|
194
|
-
export interface IDisposable {
|
|
195
|
-
[disposeSymbol](): void;
|
|
196
|
-
}
|
|
197
|
-
|
|
198
190
|
// @public @sealed
|
|
199
191
|
export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
|
|
200
192
|
attach(props?: ContainerAttachProps): Promise<string>;
|
|
@@ -363,8 +355,6 @@ export enum IntervalType {
|
|
|
363
355
|
// (undocumented)
|
|
364
356
|
Simple = 0,
|
|
365
357
|
SlideOnRemove = 2,// SlideOnRemove is default behavior - all intervals are SlideOnRemove
|
|
366
|
-
// @internal
|
|
367
|
-
Transient = 4
|
|
368
358
|
}
|
|
369
359
|
|
|
370
360
|
// @public
|
|
@@ -621,9 +611,9 @@ export type NodeFromSchemaUnsafe<T extends Unenforced<TreeNodeSchema>> = T exten
|
|
|
621
611
|
// @public
|
|
622
612
|
export interface NodeInDocumentConstraint {
|
|
623
613
|
// (undocumented)
|
|
624
|
-
node: TreeNode;
|
|
614
|
+
readonly node: TreeNode;
|
|
625
615
|
// (undocumented)
|
|
626
|
-
type: "nodeInDocument";
|
|
616
|
+
readonly type: "nodeInDocument";
|
|
627
617
|
}
|
|
628
618
|
|
|
629
619
|
// @public
|
|
@@ -654,7 +644,7 @@ export type RestrictiveReadonlyRecord<K extends symbol | string, T> = {
|
|
|
654
644
|
|
|
655
645
|
// @public
|
|
656
646
|
export interface Revertible {
|
|
657
|
-
|
|
647
|
+
dispose(): void;
|
|
658
648
|
revert(): void;
|
|
659
649
|
revert(dispose: boolean): void;
|
|
660
650
|
readonly status: RevertibleStatus;
|
|
@@ -680,12 +670,12 @@ export interface RunTransaction {
|
|
|
680
670
|
<TView extends TreeView<ImplicitFieldSchema>, TResult>(tree: TView, transaction: (root: TView["root"]) => TResult | typeof rollback): TResult | typeof rollback;
|
|
681
671
|
<TNode extends TreeNode>(node: TNode, transaction: (node: TNode) => void): void;
|
|
682
672
|
<TView extends TreeView<ImplicitFieldSchema>>(tree: TView, transaction: (root: TView["root"]) => void): void;
|
|
683
|
-
<TNode extends TreeNode, TResult>(node: TNode, transaction: (node: TNode) => TResult, preconditions?: TransactionConstraint[]): TResult;
|
|
684
|
-
<TView extends TreeView<ImplicitFieldSchema>, TResult>(tree: TView, transaction: (root: TView["root"]) => TResult, preconditions?: TransactionConstraint[]): TResult;
|
|
685
|
-
<TNode extends TreeNode, TResult>(node: TNode, transaction: (node: TNode) => TResult | typeof rollback, preconditions?: TransactionConstraint[]): TResult | typeof rollback;
|
|
686
|
-
<TView extends TreeView<ImplicitFieldSchema>, TResult>(tree: TView, transaction: (root: TView["root"]) => TResult | typeof rollback, preconditions?: TransactionConstraint[]): TResult | typeof rollback;
|
|
687
|
-
<TNode extends TreeNode>(node: TNode, transaction: (node: TNode) => void, preconditions?: TransactionConstraint[]): void;
|
|
688
|
-
<TView extends TreeView<ImplicitFieldSchema>>(tree: TView, transaction: (root: TView["root"]) => void, preconditions?: TransactionConstraint[]): void;
|
|
673
|
+
<TNode extends TreeNode, TResult>(node: TNode, transaction: (node: TNode) => TResult, preconditions?: readonly TransactionConstraint[]): TResult;
|
|
674
|
+
<TView extends TreeView<ImplicitFieldSchema>, TResult>(tree: TView, transaction: (root: TView["root"]) => TResult, preconditions?: readonly TransactionConstraint[]): TResult;
|
|
675
|
+
<TNode extends TreeNode, TResult>(node: TNode, transaction: (node: TNode) => TResult | typeof rollback, preconditions?: readonly TransactionConstraint[]): TResult | typeof rollback;
|
|
676
|
+
<TView extends TreeView<ImplicitFieldSchema>, TResult>(tree: TView, transaction: (root: TView["root"]) => TResult | typeof rollback, preconditions?: readonly TransactionConstraint[]): TResult | typeof rollback;
|
|
677
|
+
<TNode extends TreeNode>(node: TNode, transaction: (node: TNode) => void, preconditions?: readonly TransactionConstraint[]): void;
|
|
678
|
+
<TView extends TreeView<ImplicitFieldSchema>>(tree: TView, transaction: (root: TView["root"]) => void, preconditions?: readonly TransactionConstraint[]): void;
|
|
689
679
|
readonly rollback: typeof rollback;
|
|
690
680
|
}
|
|
691
681
|
|
|
@@ -979,6 +969,7 @@ export type TreeObjectNodeUnsafe<T extends Unenforced<RestrictiveReadonlyRecord<
|
|
|
979
969
|
export enum TreeStatus {
|
|
980
970
|
Deleted = 2,
|
|
981
971
|
InDocument = 0,
|
|
972
|
+
New = 3,
|
|
982
973
|
Removed = 1
|
|
983
974
|
}
|
|
984
975
|
|