Class Atom<T>

Mutable wrapper for an (usually) immutable value. Support for watches.

Type Parameters

Implements

IAtom<T>
IEquiv

Index

Constructors

constructor

new Atom<T>(val, valid?): Atom<T>
Type Parameters
- T
Parameters
- val: T
- Optional valid: Predicate<T>
Returns Atom<T>
- Defined in atom/src/atom.ts:38

Properties

`Protected` _value

_value: T

`Protected` _watches

_watches: any

`Protected` valid

valid: undefined | Predicate<T>

Accessors

value

get value(): T
Returns T
- Defined in atom/src/atom.ts:46
set value(val): void
Parameters
- val: T
Returns void
- Defined in atom/src/atom.ts:50

Methods

addWatch

addWatch(id, fn): boolean
Parameters
- id: string
- fn: Watch<T>
Returns boolean
Implementation of IAtom.addWatch
- Defined in atom/src/atom.ts:176

deref

deref(): T
Returns wrapped value.
Returns T
Implementation of IAtom.deref
- Defined in atom/src/atom.ts:54

equiv

equiv(o): boolean
Parameters
- o: any
Returns boolean
Implementation of IEquiv.equiv
- Defined in atom/src/atom.ts:58

notifyWatches

notifyWatches(old, prev): void
Parameters
- old: T
- prev: T
Returns void
Implementation of IAtom.notifyWatches
- Defined in atom/src/atom.ts:182

release

release(): boolean
Returns boolean
Implementation of IAtom.release
- Defined in atom/src/atom.ts:184

removeWatch

removeWatch(id): boolean
Parameters
- id: string
Returns boolean
Implementation of IAtom.removeWatch
- Defined in atom/src/atom.ts:179

reset

reset(val): T
Parameters
- val: T
Returns T
Implementation of IAtom.reset
- Defined in atom/src/atom.ts:62

resetIn

resetIn(path, val): T
Parameters
- path: readonly []
- val: T
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:72
resetIn<A>(path, val): T
Type Parameters
- A
Parameters
- path: Path1<T, A>
- val: ValNReducer<T, A, []>
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:73
resetIn<A, B>(path, val): T
Type Parameters
- A
- B
Parameters
- path: Path2<T, A, B>
- val: ValNReducer<T, A, [B]>
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:74
resetIn<A, B, C>(path, val): T
Type Parameters
- A
- B
- C
Parameters
- path: Path3<T, A, B, C>
- val: ValNReducer<T, A, [B, C]>
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:75
resetIn<A, B, C, D>(path, val): T
Type Parameters
- A
- B
- C
- D
Parameters
- path: Path4<T, A, B, C, D>
- val: ValNReducer<T, A, [B, C, D]>
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:76
resetIn<A, B, C, D, E>(path, val): T
Type Parameters
- A
- B
- C
- D
- E
Parameters
- path: Path5<T, A, B, C, D, E>
- val: ValNReducer<T, A, [B, C, D, E]>
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:80
resetIn<A, B, C, D, E, F>(path, val): T
Type Parameters
- A
- B
- C
- D
- E
- F
Parameters
- path: Path6<T, A, B, C, D, E, F>
- val: ValNReducer<T, A, [B, C, D, E, F]>
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:84
resetIn<A, B, C, D, E, F, G>(path, val): T
Type Parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- path: Path7<T, A, B, C, D, E, F, G>
- val: ValNReducer<T, A, [B, C, D, E, F, G]>
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:88
resetIn<A, B, C, D, E, F, G, H>(path, val): T
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- path: Path8<T, A, B, C, D, E, F, G, H>
- val: ValNReducer<T, A, [B, C, D, E, F, G, H]>
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:92
resetIn<A, B, C, D, E, F, G, H>(path, val): T
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- path: DeepPath<T, A, B, C, D, E, F, G, H>
- val: any
Returns T
Implementation of IAtom.resetIn
- Defined in atom/src/atom.ts:96

resetInUnsafe

resetInUnsafe(path, val): T
Parameters
- path: Path
- val: any
Returns T
Implementation of IAtom.resetInUnsafe
- Defined in atom/src/atom.ts:104

swap

swap(fn, ...args): T
Parameters
- fn: SwapFn<T, T>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swap
- Defined in atom/src/atom.ts:108

swapIn

swapIn<A>(path, fn, ...args): T
Type Parameters
- A
Parameters
- path: readonly []
- fn: SwapFn<T, T>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:112
swapIn<A>(path, fn, ...args): T
Type Parameters
- A
Parameters
- path: Path1<T, A>
- fn: SwapFn<OptVal<IsOptR<T, A, []>, ValNReducer<T, A, []>>, ValNReducer<T, A, []>>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:113
swapIn<A, B>(path, fn, ...args): T
Type Parameters
- A
- B
Parameters
- path: Path2<T, A, B>
- fn: SwapFn<OptVal<IsOptR<T, A, [B]>, ValNReducer<T, A, [B]>>, ValNReducer<T, A, [B]>>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:118
swapIn<A, B, C>(path, fn, ...args): T
Type Parameters
- A
- B
- C
Parameters
- path: Path3<T, A, B, C>
- fn: SwapFn<OptVal<IsOptR<T, A, [B, C]>, ValNReducer<T, A, [B, C]>>, ValNReducer<T, A, [B, C]>>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:123
swapIn<A, B, C, D>(path, fn, ...args): T
Type Parameters
- A
- B
- C
- D
Parameters
- path: Path4<T, A, B, C, D>
- fn: SwapFn<OptVal<IsOptR<T, A, [B, C, D]>, ValNReducer<T, A, [B, C, D]>>, ValNReducer<T, A, [B, C, D]>>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:128
swapIn<A, B, C, D, E>(path, fn, ...args): T
Type Parameters
- A
- B
- C
- D
- E
Parameters
- path: Path5<T, A, B, C, D, E>
- fn: SwapFn<OptVal<IsOptR<T, A, [B, C, D, E]>, ValNReducer<T, A, [B, C, D, E]>>, ValNReducer<T, A, [B, C, D, E]>>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:133
swapIn<A, B, C, D, E, F>(path, fn, ...args): T
Type Parameters
- A
- B
- C
- D
- E
- F
Parameters
- path: Path6<T, A, B, C, D, E, F>
- fn: SwapFn<OptVal<IsOptR<T, A, [B, C, D, E, F]>, ValNReducer<T, A, [B, C, D, E, F]>>, ValNReducer<T, A, [B, C, D, E, F]>>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:138
swapIn<A, B, C, D, E, F, G>(path, fn, ...args): T
Type Parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- path: Path7<T, A, B, C, D, E, F, G>
- fn: SwapFn<OptVal<IsOptR<T, A, [B, C, D, E, F, G]>, ValNReducer<T, A, [B, C, D, E, F, G]>>, ValNReducer<T, A, [B, C, D, E, F, G]>>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:146
swapIn<A, B, C, D, E, F, G, H>(path, fn, ...args): T
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- path: Path8<T, A, B, C, D, E, F, G, H>
- fn: SwapFn<OptVal<IsOptR<T, A, [B, C, D, E, F, G, H]>, ValNReducer<T, A, [B, C, D, E, F, G, H]>>, ValNReducer<T, A, [B, C, D, E, F, G, H]>>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:154
swapIn<A, B, C, D, E, F, G, H>(path, fn, ...args): T
Type Parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- path: DeepPath<T, A, B, C, D, E, F, G, H>
- fn: SwapFn<any, any>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapIn
- Defined in atom/src/atom.ts:162

swapInUnsafe

swapInUnsafe(path, fn, ...args): T
Parameters
- path: Path
- fn: SwapFn<any, any>
- Rest ...args: any[]
Returns T
Implementation of IAtom.swapInUnsafe
- Defined in atom/src/atom.ts:171

Class Atom<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Atom<T>

Properties

Protected _value

Protected _watches

Protected valid

Accessors

value

Returns T

Parameters

Returns void

Methods

addWatch

Parameters

Returns boolean

deref

Returns T

equiv

Parameters

Returns boolean

notifyWatches

Parameters

Returns void

release

Returns boolean

removeWatch

Parameters

Returns boolean

reset

Parameters

Returns T

resetIn

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

resetInUnsafe

Parameters

Returns T

swap

Parameters

Returns T

swapIn

Type Parameters

`Protected` _value

`Protected` _watches

`Protected` valid