TreeBranchFork Interface
A branch of a SharedTree that has merged from another branch.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
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.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
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. |