ISharedMapEvents Interface

Packages > fluid-framework > ISharedMapEvents

Events emitted in response to changes to the map data.

“valueChanged”

The valueChanged event is emitted when a key is set or deleted.

Listener signature

(
    changed: IValueChanged,
    local: boolean,
    op: ISequencedDocumentMessage | null,
    target: IEventThisPlaceHolder,
) => void
  • changed - Information on the key that changed and its value prior to the change.

  • local - Whether the change originated from the this client.

  • op - The op that caused the change in value.

  • target - The map itself.

“clear”

The clear event is emitted when the map is cleared.

Listener signature

(local: boolean, op: ISequencedDocumentMessage | null, target: IEventThisPlaceHolder) => void
  • local - Whether the clear originated from the this client.

  • op - The op that caused the clear.

  • target - The map itself.

Signature:

export interface ISharedMapEvents extends ISharedObjectEvents 

Extends: