IDirectoryEvents Interface

Events emitted in response to changes to the directory data.

Signature

export interface IDirectoryEvents extends IEvent

Extends: IEvent

Remarks

The following is the list of events emitted.

### "containedValueChanged"

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

• target - The IDirectory itself.

### "subDirectoryCreated"

The subDirectoryCreated event is emitted when a subdirectory is created.

#### Listener signature

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

• path - The relative path to the subdirectory that is created. It is relative from the object which raises the event.

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

• target - The ISharedDirectory itself.

### "subDirectoryDeleted"

The subDirectoryDeleted event is emitted when a subdirectory is deleted.

#### Listener signature

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

• path - The relative path to the subdirectory that is deleted. It is relative from the object which raises the event.

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

• target - The ISharedDirectory itself.

### "disposed"

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

#### Listener signature

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

• target - The IDirectory itself.

Call Signatures

CallSignature	Description
(event: "containedValueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any
(event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any
(event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any
(event: "disposed", listener: (target: IEventThisPlaceHolder) => void): any

Call Signature Details

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

Signature

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

(event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any

Signature

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

(event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any

Signature

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

(event: "disposed", listener: (target: IEventThisPlaceHolder) => void): any

Signature

(event: "disposed", listener: (target: IEventThisPlaceHolder) => void): any;