ITrackingGroup Interface
Packages > @fluidframework/merge-tree > ITrackingGroup
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/merge-tree/legacy.
For more information about our API support guarantees, see here .
Signature
export interface ITrackingGroup
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| size |
Alpha
|
number | |
| tracked |
Alpha
|
readonly Trackable[] |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| has(trackable) |
Alpha
|
boolean | |
| link(trackable) |
Alpha
|
void | |
| unlink(trackable) |
Alpha
|
boolean |
Property Details
size
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
size: number;
Type: number
tracked
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
tracked: readonly Trackable[];
Type: readonly Trackable []
Method Details
has
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
has(trackable: Trackable): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| trackable | Trackable |
Returns
Return type: boolean
link
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
link(trackable: Trackable): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| trackable | Trackable |
unlink
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
unlink(trackable: Trackable): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| trackable | Trackable |
Returns
Return type: boolean