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

Hierarchy

Ref
- ElmRef

Index

Constructors

constructor

Accessors

r

Methods

Constructors

constructor

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

- Defined in mimbl/src/api/mim.ts:757
Parameters
- Optional listener: RefFunc<T>
- Optional initialReferene: T
Returns Ref

Accessors

r

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

- Defined in mimbl/src/api/mim.ts:787
Get accessor for the reference value

Returns T
- Defined in mimbl/src/api/mim.ts:790
Set accessor for the reference value

Parameters
- v: T
Returns void

Methods

addListener

addListener(listener: RefFunc<T>): void

- Defined in mimbl/src/api/mim.ts:771
Adds a callback that will be invoked when the value of the reference changes.

Parameters
- listener: RefFunc<T>
Returns void

removeListener

removeListener(listener: RefFunc<T>): void

- Defined in mimbl/src/api/mim.ts:780
Removes a callback that was added with addListener.

Parameters
- listener: RefFunc<T>
Returns void

Generated using TypeDoc