ISharedDirectoryEvents Interface

Packages > fluid-framework > ISharedDirectoryEvents

Events emitted in response to changes to the directory data. These events only emit on the ISharedDirectory itself, and not on subdirectories.

“valueChanged”

The valueChanged event is emitted when a key is set or deleted. This is emitted for any key in the ISharedDirectory or any subdirectory.

Listener signature 

(
    changed: IDirectoryValueChanged,
    local: boolean,
    op: ISequencedDocumentMessage | null,
    target: IEventThisPlaceHolder,
) => void

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

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

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

  • target - The ISharedDirectory itself.

“clear”

The clear event is emitted when the ISharedDirectory 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 ISharedDirectory itself.

Signature:

export interface ISharedDirectoryEvents extends ISharedObjectEvents

Extends: