ISerializedInterval Interface
Packages > fluid-framework > ISerializedInterval
Serialized object representation of an interval. This representation is used for ops that create or change intervals.
This API is provided for existing users, but is not recommended for new users.
To use, import via fluid-framework/legacy.
For more information about our API support guarantees, see here .
Signature
export interface ISerializedInterval
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| end | Alpha |
number | "start" | "end" | End position of the interval | |
| endSide | Alpha |
optional |
Side | |
| intervalType | Alpha |
IntervalType | Interval type to create | |
| properties | Alpha |
optional |
PropertySet | Any properties the interval has |
| sequenceNumber | Alpha |
number | Sequence number at which start and end should be interpreted |
|
| start | Alpha |
number | "start" | "end" | Start position of the interval | |
| startSide | Alpha |
optional |
Side | |
| stickiness | Alpha |
optional |
IntervalStickiness | The stickiness of this interval |
Property Details
end
End position of the interval
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
end: number | "start" | "end";
Type: number | “start” | “end”
endSide
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
endSide?: Side;
Type: Side
intervalType
Interval type to create
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
intervalType: IntervalType;
Type: IntervalType
properties
Any properties the interval has
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
properties?: PropertySet;
Type: PropertySet
sequenceNumber
Sequence number at which start and end should be interpreted
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
sequenceNumber: number;
Type: number
Remarks
It’s unclear that this is necessary to store here. This should just be the refSeq on the op that modified the interval, which should be available via other means. At the time of writing, it’s not plumbed through to the reconnect/rebase code, however, which does need it.
start
Start position of the interval
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
start: number | "start" | "end";
Type: number | “start” | “end”
startSide
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
startSide?: Side;
Type: Side
stickiness
The stickiness of this interval
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
stickiness?: IntervalStickiness;
Type: IntervalStickiness