• Preparing search index...
  • The search index is not available
value-enhancer - v5.6.2
  • value-enhancer
  • index
  • flatten

Function flatten

  • flatten<TValOrValue>(val): ReadonlyVal<UnwrapVal<TValOrValue>>
  • Flatten a val of val to a val of the inner val value.

    Type Parameters

    • TValOrValue = any

    Parameters

    • val: ReadonlyVal<TValOrValue>

      Input value.

    Returns ReadonlyVal<UnwrapVal<TValOrValue>>

    A readonly val with value of inner val.

    Example

    import { flatten, val } from "value-enhancer";

    const inner$ = val(12);
    const outer$ = val(inner$);

    const flattened$ = flatten(outer$);

    inner$.value === flattened$.value; // true
    • Defined in src/flatten.ts:53
  • flatten<TSrcValue, TValOrValue>(val, get?, config?): ReadonlyVal<UnwrapVal<TValOrValue>>
  • Flatten an inner val extracted from a source val to a val of the inner val value.

    Type Parameters

    • TSrcValue = any
    • TValOrValue = any

    Parameters

    • val: ReadonlyVal<TSrcValue>

      Input value.

    • Optional get: ((value) => TValOrValue)

      extract inner val or value from source val.

        • (value): TValOrValue
        • Parameters

          • value: TSrcValue

          Returns TValOrValue

    • Optional config: ValConfig<UnwrapVal<TValOrValue>>

    Returns ReadonlyVal<UnwrapVal<TValOrValue>>

    A readonly val with value of inner val.

    Example

    import { flatten, val } from "value-enhancer";

    const inner$ = val(12);
    const outer$ = val({ inner$ });

    const flattened$ = flatten(outer$, ({ inner$ }) => inner$);

    inner$.value === flattened$.value; // true
    • Defined in src/flatten.ts:53

Settings

Theme

value-enhancer - v5.6.2
  • Loading...