Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "update-in"

Index

Functions

updateIn

  • updateIn<T>(state: T, path: Path0, fn: UpdateFn<T, T>): T
  • updateIn<T, A>(state: T, path: Path1<T, A>, fn: UpdateFn<OptPathVal<T, [A]>, PathVal<T, [A]>>, ...args: any[]): T
  • updateIn<T, A, B>(state: T, path: Path2<T, A, B>, fn: UpdateFn<OptPathVal<T, [A, B]>, PathVal<T, [A, B]>>, ...args: any[]): T
  • updateIn<T, A, B, C>(state: T, path: Path3<T, A, B, C>, fn: UpdateFn<OptPathVal<T, [A, B, C]>, PathVal<T, [A, B, C]>>, ...args: any[]): T
  • updateIn<T, A, B, C, D>(state: T, path: Path4<T, A, B, C, D>, fn: UpdateFn<OptPathVal<T, [A, B, C, D]>, PathVal<T, [A, B, C, D]>>, ...args: any[]): T
  • updateIn<T, A, B, C, D, E>(state: T, path: Path5<T, A, B, C, D, E>, fn: UpdateFn<OptPathVal<T, [A, B, C, D, E]>, PathVal<T, [A, B, C, D, E]>>, ...args: any[]): T
  • updateIn<T, A, B, C, D, E, F>(state: T, path: Path6<T, A, B, C, D, E, F>, fn: UpdateFn<OptPathVal<T, [A, B, C, D, E, F]>, PathVal<T, [A, B, C, D, E, F]>>, ...args: any[]): T
  • updateIn<T, A, B, C, D, E, F, G>(state: T, path: Path7<T, A, B, C, D, E, F, G>, fn: UpdateFn<OptPathVal<T, [A, B, C, D, E, F, G]>, PathVal<T, [A, B, C, D, E, F, G]>>, ...args: any[]): T
  • updateIn<T, A, B, C, D, E, F, G, H>(state: T, path: Path8<T, A, B, C, D, E, F, G, H>, fn: UpdateFn<OptPathVal<T, [A, B, C, D, E, F, G, H]>, PathVal<T, [A, B, C, D, E, F, G, H]>>, ...args: any[]): T
  • updateIn<T, A, B, C, D, E, F, G, H>(state: T, path: DeepPath<T, A, B, C, D, E, F, G, H>, fn: UpdateFn<any, any>, ...args: any[]): T
  • Type checked version of updateIn. Only the first 8 path levels are type checked.

    Type parameters

    • T

    Parameters

    • state: T

      -

    • path: Path0

      -

    • fn: UpdateFn<T, T>

      -

    Returns T

  • Type parameters

    • T

    • A

    Parameters

    • state: T
    • path: Path1<T, A>
    • fn: UpdateFn<OptPathVal<T, [A]>, PathVal<T, [A]>>
    • Rest ...args: any[]

    Returns T

  • Type parameters

    • T

    • A

    • B

    Parameters

    • state: T
    • path: Path2<T, A, B>
    • fn: UpdateFn<OptPathVal<T, [A, B]>, PathVal<T, [A, B]>>
    • Rest ...args: any[]

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    Parameters

    • state: T
    • path: Path3<T, A, B, C>
    • fn: UpdateFn<OptPathVal<T, [A, B, C]>, PathVal<T, [A, B, C]>>
    • Rest ...args: any[]

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    Parameters

    • state: T
    • path: Path4<T, A, B, C, D>
    • fn: UpdateFn<OptPathVal<T, [A, B, C, D]>, PathVal<T, [A, B, C, D]>>
    • Rest ...args: any[]

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    Parameters

    • state: T
    • path: Path5<T, A, B, C, D, E>
    • fn: UpdateFn<OptPathVal<T, [A, B, C, D, E]>, PathVal<T, [A, B, C, D, E]>>
    • Rest ...args: any[]

    Returns T

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    Parameters

    • state: T
    • path: Path6<T, A, B, C, D, E, F>
    • fn: UpdateFn<OptPathVal<T, [A, B, C, D, E, F]>, PathVal<T, [A, B, C, D, E, F]>>
    • Rest ...args: any[]

    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>
    • fn: UpdateFn<OptPathVal<T, [A, B, C, D, E, F, G]>, PathVal<T, [A, B, C, D, E, F, G]>>
    • Rest ...args: any[]

    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>
    • fn: UpdateFn<OptPathVal<T, [A, B, C, D, E, F, G, H]>, PathVal<T, [A, B, C, D, E, F, G, H]>>
    • Rest ...args: any[]

    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>
    • fn: UpdateFn<any, any>
    • Rest ...args: any[]

    Returns T

Const updateInUnsafe

  • updateInUnsafe<T>(state: any, path: Path, fn: UpdateFn<T, T>, ...args: any[]): any
  • Similar to setInUnsafe, but applies given function to current path value (incl. any additional/optional arguments passed to updateIn) and uses result as new value. Does not modify original state.

    remarks

    Unchecked version of updateIn. The type parameter T can be used to indicate the type of the nested value to be updated (default: any).

    example
    add = (x: number, y: number) => x + y;
    updateInUnsafe({ a: { b: { c: 23 } } }, "a.b.c", add, 10);
    // { a: { b: { c: 33 } } }
    
    // type checked
    updateIn({ a: { b: { c: 23 } } }, ["a","b","c"], add, 10);
    // { a: { b: { c: 33 } } }
    
    // type error (value at "a.b" is not a number)
    updateIn({ a: { b: { c: 23 } } }, ["a","b"], add, 10);

    Type parameters

    • T

    Parameters

    • state: any

      state to update

    • path: Path

      update path

    • fn: UpdateFn<T, T>

      update function

    • Rest ...args: any[]

      optional args for fn

    Returns any

Generated using TypeDoc