Function unset

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    Parameters

    • source: T

      source, in which the nested value should be removed.

    • path: [K1]

      path array of the nested value in the source

    Returns Without<T, K1>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    Parameters

    • source: T

      source, in which the nested value should be removed.

    • path: [K1, K2]

      path array of the nested value in the source

    Returns Unset2<T, K1, K2>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    Parameters

    • source: T

      source, in which the nested value should be removed.

    • path: [K1, K2, K3]

      path array of the nested value in the source

    Returns Unset3<T, K1, K2, K3>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    • K4 extends string | number | symbol

    Parameters

    • source: T

      source, in which the nested value should be removed.

    • path: [K1, K2, K3, K4]

      path array of the nested value in the source

    Returns Unset4<T, K1, K2, K3, K4>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    • K4 extends string | number | symbol

    • K5 extends string | number | symbol

    Parameters

    • source: T

      source, in which the nested value should be removed.

    • path: [K1, K2, K3, K4, K5]

      path array of the nested value in the source

    Returns Unset5<T, K1, K2, K3, K4, K5>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    Parameters

    • source: Nullable<T>

      source, in which the nested value should be removed.

    • path: [K1]

      path array of the nested value in the source

    Returns Nullable<Without<T, K1>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    Parameters

    • source: Nullable<T>

      source, in which the nested value should be removed.

    • path: [K1, K2]

      path array of the nested value in the source

    Returns Nullable<Unset2<T, K1, K2>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    Parameters

    • source: Nullable<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3]

      path array of the nested value in the source

    Returns Nullable<Unset3<T, K1, K2, K3>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    • K4 extends string | number | symbol

    Parameters

    • source: Nullable<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3, K4]

      path array of the nested value in the source

    Returns Nullable<Unset4<T, K1, K2, K3, K4>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    • K4 extends string | number | symbol

    • K5 extends string | number | symbol

    Parameters

    • source: Nullable<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3, K4, K5]

      path array of the nested value in the source

    Returns Nullable<Unset5<T, K1, K2, K3, K4, K5>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    Parameters

    • source: Undefinable<T>

      source, in which the nested value should be removed.

    • path: [K1]

      path array of the nested value in the source

    Returns Undefinable<Without<T, K1>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    Parameters

    • source: Undefinable<T>

      source, in which the nested value should be removed.

    • path: [K1, K2]

      path array of the nested value in the source

    Returns Undefinable<Unset2<T, K1, K2>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    Parameters

    • source: Undefinable<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3]

      path array of the nested value in the source

    Returns Undefinable<Unset3<T, K1, K2, K3>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    • K4 extends string | number | symbol

    Parameters

    • source: Undefinable<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3, K4]

      path array of the nested value in the source

    Returns Undefinable<Unset4<T, K1, K2, K3, K4>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    • K4 extends string | number | symbol

    • K5 extends string | number | symbol

    Parameters

    • source: Undefinable<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3, K4, K5]

      path array of the nested value in the source

    Returns Undefinable<Unset5<T, K1, K2, K3, K4, K5>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    Parameters

    • source: Optional<T>

      source, in which the nested value should be removed.

    • path: [K1]

      path array of the nested value in the source

    Returns Optional<Without<T, K1>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    Parameters

    • source: Optional<T>

      source, in which the nested value should be removed.

    • path: [K1, K2]

      path array of the nested value in the source

    Returns Optional<Unset2<T, K1, K2>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    Parameters

    • source: Optional<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3]

      path array of the nested value in the source

    Returns Optional<Unset3<T, K1, K2, K3>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    • K4 extends string | number | symbol

    Parameters

    • source: Optional<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3, K4]

      path array of the nested value in the source

    Returns Optional<Unset4<T, K1, K2, K3, K4>>

  • Removes the value on the specified path in source value. If the value is an array, the behavior is similar to splicing shallow copy of the value. If the value is object, the value is removed from the shallow copy using delete keyword.

    Source value can be nullable or undefinable, and path is treated as if the source (and all intermediate) values are required (because nullable and undefinable types can't have keys).

    Path supports up to 5 elements. This means, you are not able to use this helper if you need more.

    Returns

    source value with removed value

    Type Parameters

    • T

    • K1 extends string | number | symbol

    • K2 extends string | number | symbol

    • K3 extends string | number | symbol

    • K4 extends string | number | symbol

    • K5 extends string | number | symbol

    Parameters

    • source: Optional<T>

      source, in which the nested value should be removed.

    • path: [K1, K2, K3, K4, K5]

      path array of the nested value in the source

    Returns Optional<Unset5<T, K1, K2, K3, K4, K5>>

Generated using TypeDoc