omit

特定のキーを省略した新しいオブジェクトを生成します。

この関数はオブジェクトとキーの配列を受け取り、指定されたキーに対応するプロパティを除いた新しいオブジェクトを返します。

インターフェース

function omit<T extends Record<string, any>, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;

パラメータ

• obj (T): キーを省略するオブジェクトです。
• keys (K[]): オブジェクトから省略するキーの配列です。

戻り値

(Omit<T, K>): 指定されたキーが省略された新しいオブジェクトです。

例

const obj = { a: 1, b: 2, c: 3 };
const result = omit(obj, ['b', 'c']);
// 結果は次のようになります { a: 1 }

Lodashとの互換性

es-toolkit/compatからomit関数をインポートすると、深いパスを省略することができます。

import { omit } from 'es-toolkit/compat';

const obj = { a: { b: { c: 1 } }, d: { e: 2 }, f: { g: 3 }, 'f.g': 4 };
const result = omit(obj, ['a.b.c', 'f.g']);
// result will be { a: { b: {} }, d: { e: 2 }, f: { g: 3 } }