Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "set-in"

Index

Functions

setIn

  • setIn<T>(state: T, path: Path0, val: T): T
  • setIn<T, A>(state: T, path: Path1<T, A>, val: PathVal<T, [A]>): T
  • setIn<T, A, B>(state: T, path: Path2<T, A, B>, val: PathVal<T, [A, B]>): T
  • setIn<T, A, B, C>(state: T, path: Path3<T, A, B, C>, val: PathVal<T, [A, B, C]>): T
  • setIn<T, A, B, C, D>(state: T, path: Path4<T, A, B, C, D>, val: PathVal<T, [A, B, C, D]>): T
  • setIn<T, A, B, C, D, E>(state: T, path: Path5<T, A, B, C, D, E>, val: PathVal<T, [A, B, C, D, E]>): T
  • setIn<T, A, B, C, D, E, F>(state: T, path: Path6<T, A, B, C, D, E, F>, val: PathVal<T, [A, B, C, D, E, F]>): T
  • setIn<T, A, B, C, D, E, F, G>(state: T, path: Path7<T, A, B, C, D, E, F, G>, val: PathVal<T, [A, B, C, D, E, F, G]>): T
  • setIn<T, A, B, C, D, E, F, G, H>(state: T, path: Path8<T, A, B, C, D, E, F, G, H>, val: PathVal<T, [A, B, C, D, E, F, G, H]>): T
  • setIn<T, A, B, C, D, E, F, G, H>(state: T, path: DeepPath<T, A, B, C, D, E, F, G, H>, val: any): any
  • Type checked, immediate use setter, i.e. same as: defSetterUnsafe(path)(state, val).

    remarks

    Only the first 8 path levels are type checked.

    example
    // type checked path & value
    setIn({ a: { b: { c: 23 } } }, ["a", "b", "c"], 24);
    // { a: { b: { c: 24 } } }
    
    // error (wrong value type)
    setIn({ a: { b: { c: 23 } } }, ["a", "b", "c"], "24");

    Type parameters

    • T

    Parameters

    • state: T

      -

    • path: Path0

      -

    • val: T

      -

    Returns T

  • Type parameters

    • T

    • A

    Parameters

    • state: T
    • path: Path1<T, A>
    • val: PathVal<T, [A]>

    Returns T

  • Type parameters

    • T

    • A

    • B

    Parameters

    • state: T
    • path: Path2<T, A, B>
    • val: PathVal<T, [A, B]>

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    Parameters

    • state: T
    • path: Path3<T, A, B, C>
    • val: PathVal<T, [A, B, C]>

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    Parameters

    • state: T
    • path: Path4<T, A, B, C, D>
    • val: PathVal<T, [A, B, C, D]>

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    Parameters

    • state: T
    • path: Path5<T, A, B, C, D, E>
    • val: PathVal<T, [A, B, C, D, E]>

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    Parameters

    • state: T
    • path: Path6<T, A, B, C, D, E, F>
    • val: PathVal<T, [A, B, C, D, E, F]>

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    Parameters

    • state: T
    • path: Path7<T, A, B, C, D, E, F, G>
    • val: PathVal<T, [A, B, C, D, E, F, G]>

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    Parameters

    • state: T
    • path: Path8<T, A, B, C, D, E, F, G, H>
    • val: PathVal<T, [A, B, C, D, E, F, G, H]>

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    Parameters

    • state: T
    • path: DeepPath<T, A, B, C, D, E, F, G, H>
    • val: any

    Returns any

Const setInUnsafe

  • setInUnsafe<T>(state: any, path: Path, val: T): any
  • Unchecked version of setIn.

    remarks

    The type parameter T can be used to indicate the type of the nested value to be set (default: any).

    example
    setInUnsafe({}, "a.b.c", 23);
    // { a: { b: { c: 23} } }

    Type parameters

    • T

    Parameters

    • state: any

      -

    • path: Path

      -

    • val: T

    Returns any

Generated using TypeDoc