Skip to main content
Version: v1

PropertiesManager Class

Signature

export declare class PropertiesManager

Constructors

Constructor Description
(constructor)() Constructs a new instance of the PropertiesManager class

Methods

Method Return Type Description
ackPendingProperties(annotateOp) void
addProperties(oldProps, newProps, op, seq, collaborating) PropertySet | undefined
copyTo(oldProps, newProps, newManager) PropertySet | undefined
hasPendingProperties() boolean

Constructor Details

(constructor)

Constructs a new instance of the PropertiesManager class

Signature

constructor();

Method Details

ackPendingProperties

Signature

ackPendingProperties(annotateOp: IMergeTreeAnnotateMsg): void;

Parameters

Parameter Type Description
annotateOp IMergeTreeAnnotateMsg

addProperties

Signature

addProperties(oldProps: PropertySet, newProps: PropertySet, op?: ICombiningOp, seq?: number, collaborating?: boolean): PropertySet | undefined;

Parameters

Parameter Modifiers Type Description
oldProps PropertySet
newProps PropertySet
op optional ICombiningOp
seq optional number
collaborating optional boolean

Returns

Return type: PropertySet | undefined

copyTo

Signature

copyTo(oldProps: PropertySet, newProps: PropertySet | undefined, newManager: PropertiesManager): PropertySet | undefined;

Parameters

Parameter Type Description
oldProps PropertySet
newProps PropertySet | undefined
newManager PropertiesManager

Returns

Return type: PropertySet | undefined

hasPendingProperties

Signature

hasPendingProperties(): boolean;

Returns

Return type: boolean