Class Ref<T>

Reference class to use whenever a reference to an object is needed - for example, with JSX ref attributes and services.

Type parameters

T = any

Hierarchy

EventSlot<RefFunc<T>>
- Ref

Implements

IRef<T>

Index

Constructors

constructor

Accessors

r

Methods

Constructors

constructor

new Ref<T>(listener?: RefFunc<T>, initialReference?: T): Ref<T>

Overrides EventSlot.constructor
Type parameters
- T = any
Parameters
- Optional listener: RefFunc<T>
- Optional initialReference: T
Returns Ref<T>

Accessors

r

get r(): undefined | T
set r(v: undefined | T): void

Implementation of IRef.r

Get accessor for the reference value

Returns undefined | T
Implementation of IRef.r

Set accessor for the reference value

Parameters
- v: undefined | T
Returns void

Methods

attach

attach(listener: RefFunc<T>): void

Implementation of IRef.attach
Inherited from EventSlot.attach

Adds the given function as a listener to the event.

Parameters
- listener: RefFunc<T>
Returns void

clear

clear(): void

Inherited from EventSlot.clear

Removes all listeners to the event.

Returns void

detach

detach(listener: RefFunc<T>): void

Implementation of IRef.detach
Inherited from EventSlot.detach

Removes the given function as a listener to the event.

Parameters
- listener: RefFunc<T>
Returns void

fire

fire(...args: [newRef: T]): void

Inherited from EventSlot.fire

Method that raises the event and calls all the listeners (if any). It has the signature of the template function so only proper-types parameters can be passed to it.

Parameters
- Rest ...args: [newRef: T]
Returns void

has

has(): boolean

Implementation of IRef.has
Inherited from EventSlot.has

Determines whether this event slot has any listeners.

Returns boolean