ObjectPropertyWatcher

Retrieved from ogma.schema.watchNodeProperties() or ogma.schema.watchEdgeProperties().

objectPropertyWatcher.destroy()

Stops the watcher from being updated.

objectPropertyWatcher.getPath()

Returns the path of the data property being watched

Returns

• Array<string>

objectPropertyWatcher.getProperties()

Returns the names of the sub-property of the watched property.

Returns

• Array<string>

objectPropertyWatcher.getPropertyInfo(name)

Retrieve some information on the specified sub-property.

Arguments

• name string

Returns

• PropertyInformation|null

objectPropertyWatcher.onPropertyAdded(handler)

Triggers the specified function when a new sub-property is added (at least one node has a value for it).

Arguments

• handler function (property: string, info: PropertyInformation)

Returns

• ObjectPropertyWatcher

objectPropertyWatcher.onPropertyRemoved(handler)

Triggers the specified function when a new sub-property is removed (no node has a value for it).

Arguments

• handler function (property: string, info: PropertyInformation)

Returns

• ObjectPropertyWatcher

objectPropertyWatcher.onPropertyUpdated(handler)

Triggers when a sub-property of the watched property is updated.

Arguments

• handler function (property: string, info: PropertyInformation)

Returns

• ObjectPropertyWatcher