ISharedMapEvents Interface

Events emitted in response to changes to the map data.

Signature

export interface ISharedMapEvents extends ISharedObjectEvents

Extends: ISharedObjectEvents

Remarks

The following is the list of events emitted.

### “valueChanged”

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

#### Listener signature

(
    changed: IValueChanged,
    local: boolean,
    target: IEventThisPlaceHolder,
) => void

• changed - Information on the key that changed and its value prior to the change.

• local - Whether the change originated from this client.

• target - The map itself.

### “clear”

The clear event is emitted when the map is cleared.

#### Listener signature

(local: boolean, target: IEventThisPlaceHolder) => void

• local - Whether the clear originated from this client.

• target - The map itself.

Call Signatures

Call Signature Details

(event: “valueChanged”, listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any

Signature

(event: "valueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;

(event: “clear”, listener: (local: boolean, target: IEventThisPlaceHolder) => void): any

Signature

(event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;