TreeBranchFork Interface
A branch of a SharedTree that has merged from another branch.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
/** @sealed */
export interface TreeBranchFork extends BranchableTree, IDisposable
Extends: BranchableTree, IDisposable
Remarks
This branch should be disposed when it is no longer needed in order to free resources.
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| rebaseOnto(branch) | Alpha |
void | Rebase the changes that have been applied to this branch over all the new changes in the given branch. |
Method Details
rebaseOnto
Rebase the changes that have been applied to this branch over all the new changes in the given branch.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
rebaseOnto(branch: BranchableTree): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| branch | BranchableTree | Either the root branch or a branch that was created by a call to branch(). It is not modified by this operation. |