Skip to content

omit

返回从对象或数组中,删除指定的键或索引的新对象或者数组,返回值是普通对象或数组,不会修改入参。

Added in v0.0.1

Usage

typescript
import { omit } from 'parsnip-kit'

const obj = omit({ a: 1, b: 2, c: 3 }, ['b', 'c'] as const)
// Omit<{ a: number; b: number; c: number; }, "b" | "c">
// { a: 1 }
const arr = omit([1, 2, 3, 4], ['[1]', '3'] as const)
// Omit<number[], 1 | 3>
// [1, 3]

API

Type Parameter

ArgTypeDescription
Textends object待处理对象的类型
Rextends readonly string[]字段路径数组类型

Arguments

ArgTypeOptionalDefaultDescription
objTfalseundefined待处理的对象或数组
keysRfalseundefined需要删除的键或数组索引

Returns

Type
Omit<T, KeyOrIndex<ExtractUnion<R>>>

Reference

KeyOrIndex ExtractUnion