Class Handle<T>

Handle (weak reference) to a trackable object.

Type Parameters

T extends ITrackable<any>

Hierarchy (View Summary)

Subscribable<T | null>
- Handle

Index

Accessors

subscribed value

Methods

subscribe unsubscribe

Accessors

subscribed

get subscribed(): boolean
Whether there are any subscribers.

Returns boolean
Inherited from Subscribable.subscribed

value

get value(): null | T
The value referenced by the handle.

Returns null | T
Remarks
This is automatically set to null when the referenced object is deleted.
set value(value: null | T): void
Parameters
- value: null | T
Returns void

Methods

subscribe(subscriber: Subscriber<null | T>): void
Subscribes to be notified when an event occurs.
Parameters
- subscriber: Subscriber<null | T>
  The callback function.
Returns void
Inherited from Subscribable.subscribe

unsubscribe

unsubscribe(callback: Subscriber<null | T>): boolean
Unsubscribes.
Parameters
- callback: Subscriber<null | T>
  The callback function.
Returns boolean
True if the subscription was canceled, false otherwise.

Inherited from Subscribable.unsubscribe