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