IDirectoryEvents Interface

Packages > fluid-framework > IDirectoryEvents

Events emitted in response to changes to the directory data.


The containedValueChanged event is emitted when a key is set or deleted. As opposed to the SharedDirectory’s valueChanged event, this is emitted only on the IDirectory that directly contains the key.

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 the this client.

  • target - The IDirectory itself.


The dispose event is emitted when this sub directory is deleted.

Listener signature

(local: boolean, target: IEventThisPlaceHolder) => void
  • target - The IDirectory itself.


export interface IDirectoryEvents extends IEvent