Skip to main content
Version: v1

PropertiesManager Class

Signature

export declare class PropertiesManager

Constructors

ConstructorDescription
(constructor)()Constructs a new instance of the PropertiesManager class

Methods

MethodReturn TypeDescription
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

ParameterTypeDescription
annotateOpIMergeTreeAnnotateMsg

addProperties

Signature

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

Parameters

ParameterModifiersTypeDescription
oldPropsPropertySet
newPropsPropertySet
opoptionalICombiningOp
seqoptionalnumber
collaboratingoptionalboolean

Returns

Return type: PropertySet | undefined

copyTo

Signature

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

Parameters

ParameterTypeDescription
oldPropsPropertySet
newPropsPropertySet | undefined
newManagerPropertiesManager

Returns

Return type: PropertySet | undefined

hasPendingProperties

Signature

hasPendingProperties(): boolean;

Returns

Return type: boolean