omit

지정된 키들을 제외한 새로운 객체를 반환해요.

const result = omit(obj, keys);

레퍼런스

omit(obj, keys)

객체에서 특정 키들만 제외하고 싶을 때 omit을 사용하세요. 지정된 키에 해당하는 속성들을 제거한 새로운 객체를 반환해요.

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

// 특정 키들을 제외해요
const obj = { a: 1, b: 2, c: 3, d: 4 };
const result = omit(obj, ['b', 'c']);
// result는 { a: 1, d: 4 }가 돼요

// 존재하지 않는 키를 지정해도 에러가 발생하지 않아요
const safe = omit(obj, ['b', 'nonexistent']);
// safe는 { a: 1, c: 3, d: 4 }가 돼요

// 동적 배열도 사용할 수 있어요
const keysToOmit = Object.keys({ b: true, c: true });
const dynamic = omit(obj, keysToOmit);
// dynamic은 { a: 1, d: 4 }가 돼요

파라미터

• obj (T extends Record<PropertyKey, any>): 키를 제외할 객체예요.
• keys (readonly K[] (K extends keyof T) 또는 readonly PropertyKey[]): 객체에서 제외할 키들의 배열이에요.

반환 값

• Omit<T, K> 또는 Partial<T> - 지정된 키들이 제외된 새로운 객체를 반환해요.
  • keys가 readonly K[] 인 경우: Omit<T, K> 로 좀 더 엄격한 타입이 반환돼요.
  • keys가 readonly PropertyKey[] 인 경우: Partial<T> 로 반환돼요. 런타임에 결정되는 동적 키 배열에 유용해요.