Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "mutator"

Index

Functions

defMutator

  • defMutator<T>(path: Path0): Fn2<T, T, T>
  • defMutator<T, A>(path: Path1<T, A>): Fn2<T, PathVal<T, [A]>, T>
  • defMutator<T, A, B>(path: Path2<T, A, B>): Fn2<T, PathVal<T, [A, B]>, T>
  • defMutator<T, A, B, C>(path: Path3<T, A, B, C>): Fn2<T, PathVal<T, [A, B, C]>, T>
  • defMutator<T, A, B, C, D>(path: Path4<T, A, B, C, D>): Fn2<T, PathVal<T, [A, B, C, D]>, T>
  • defMutator<T, A, B, C, D, E>(path: Path5<T, A, B, C, D, E>): Fn2<T, PathVal<T, [A, B, C, D, E]>, T>
  • defMutator<T, A, B, C, D, E, F>(path: Path6<T, A, B, C, D, E, F>): Fn2<T, PathVal<T, [A, B, C, D, E, F]>, T>
  • defMutator<T, A, B, C, D, E, F, G>(path: Path7<T, A, B, C, D, E, F, G>): Fn2<T, PathVal<T, [A, B, C, D, E, F, G]>, T>
  • defMutator<T, A, B, C, D, E, F, G, H>(path: Path8<T, A, B, C, D, E, F, G, H>): Fn2<T, PathVal<T, [A, B, C, D, E, F, G, H]>, T>
  • defMutator<T, A, B, C, D, E, F, G, H>(path: DeepPath<T, A, B, C, D, E, F, G, H>): Fn2<T, any, any>
  • Higher-order function, similar to defSetter. Returns a function, which when called, mutates given object/array at given path location.

    remarks

    The returned function bails if any intermediate path values are non-indexable (only the very last path element can be missing in the actual object structure). If successful, returns original (mutated) object, else undefined. This function provides optimized versions for path lengths <= 4.

    Only the first 8 path levels are type checked.

    Also see defMutatorUnsafe, mutIn

    Type parameters

    • T

    Parameters

    • path: Path0

      -

    Returns Fn2<T, T, T>

  • Type parameters

    • T

    • A

    Parameters

    • path: Path1<T, A>

    Returns Fn2<T, PathVal<T, [A]>, T>

  • Type parameters

    • T

    • A

    • B

    Parameters

    • path: Path2<T, A, B>

    Returns Fn2<T, PathVal<T, [A, B]>, T>

  • Type parameters

    • T

    • A

    • B

    • C

    Parameters

    • path: Path3<T, A, B, C>

    Returns Fn2<T, PathVal<T, [A, B, C]>, T>

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    Parameters

    • path: Path4<T, A, B, C, D>

    Returns Fn2<T, PathVal<T, [A, B, C, D]>, T>

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    Parameters

    • path: Path5<T, A, B, C, D, E>

    Returns Fn2<T, PathVal<T, [A, B, C, D, E]>, T>

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    Parameters

    • path: Path6<T, A, B, C, D, E, F>

    Returns Fn2<T, PathVal<T, [A, B, C, D, E, F]>, T>

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    Parameters

    • path: Path7<T, A, B, C, D, E, F, G>

    Returns Fn2<T, PathVal<T, [A, B, C, D, E, F, G]>, T>

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    Parameters

    • path: Path8<T, A, B, C, D, E, F, G, H>

    Returns Fn2<T, PathVal<T, [A, B, C, D, E, F, G, H]>, T>

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    Parameters

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

    Returns Fn2<T, any, any>

Const defMutatorUnsafe

  • defMutatorUnsafe<T>(path: Path): Fn2<any, T, any>
  • Unchecked version of defMutator.

    remarks

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

    Type parameters

    • T

    Parameters

    • path: Path

      -

    Returns Fn2<any, T, any>

Generated using TypeDoc