Function useFlatten

useFlatten<TValOrValue>(val$): UnwrapVal<TValOrValue>
Accepts a val from anywhere and returns the latest value of the flatten val. Re-rendering is triggered when the derived value changes.
Type Parameters
- TValOrValue = any
Parameters
- val$: ReadonlyVal<TValOrValue>
  A val of val.
Returns UnwrapVal<TValOrValue>
the value of the flatten val.
- Defined in use-flatten.ts:55
useFlatten<TValOrValue>(val$?): undefined | UnwrapVal<TValOrValue>
Accepts a val from anywhere and returns the latest value of the flatten val. Re-rendering is triggered when the derived value changes.
Type Parameters
- TValOrValue = any
Parameters
- Optional val$: ReadonlyVal<TValOrValue>
  A val of val.
Returns undefined | UnwrapVal<TValOrValue>
the value of the flatten val.
- Defined in use-flatten.ts:55
useFlatten<TSrcValue, TValOrValue>(val$, get, eagerOrConfig?): UnwrapVal<TValOrValue>
Accepts a val from anywhere and returns the latest value of the flatten val. Re-rendering is triggered when the derived value changes.
Type Parameters
- TSrcValue = any
- TValOrValue = any
Parameters
- val$: ReadonlyVal<TSrcValue>
  A val of val.
- get: ((value) => TValOrValue)
  A pure function that gets the inner from val$.
  - - (value): TValOrValue
    - Parameters
      value: TSrcValue
      Returns TValOrValue
- Optional eagerOrConfig: boolean | ValConfig<UnwrapVal<TValOrValue>>
  ValConfig of Val or just the eager. Default true.
Returns UnwrapVal<TValOrValue>
the value of the flatten val.
- Defined in use-flatten.ts:55
useFlatten<TSrcValue, TValOrValue>(val$, get, eagerOrConfig?): undefined | UnwrapVal<TValOrValue>
Accepts a val from anywhere and returns the latest value of the flatten val. Re-rendering is triggered when the derived value changes.
Type Parameters
- TSrcValue = any
- TValOrValue = any
Parameters
- val$: undefined | ReadonlyVal<TSrcValue>
  A val of val.
- get: ((value) => TValOrValue)
  A pure function that gets the inner from val$.
  - - (value): TValOrValue
    - Parameters
      value: TSrcValue
      Returns TValOrValue
- Optional eagerOrConfig: boolean | ValConfig<UnwrapVal<TValOrValue>>
  ValConfig of Val or just the eager. Default true.
Returns undefined | UnwrapVal<TValOrValue>
the value of the flatten val$, or undefined if val is undefined.
- Defined in use-flatten.ts:55