Skip to main content

Interface: SafeObjectOmit()

Defined in: shared/utils/objectSafety.ts:139

Create a type-safe object with specified keys omitted.

Example​

const user = {
    id: 1,
    name: "John",
    email: "john@example.com",
    password: "secret",
};
const publicUser = safeObjectOmit(user, ["password"]);
// Type: { id: number; name: string; email: string; }

Param​

Source object

Param​

Keys to omit from the object

Call Signature​

SafeObjectOmit(obj: null | undefined, keys: readonly PropertyKey[]): Record<string, never>

Defined in: shared/utils/objectSafety.ts:143

Omitting keys from a nullish input yields an empty object.

Parameters​

obj​

null | undefined

keys​

readonly PropertyKey[]

Returns​

Record<string, never>

Call Signature​

SafeObjectOmit<T, K>(obj: T | null | undefined, keys: readonly K[]): Omit<T, K>

Defined in: shared/utils/objectSafety.ts:151

Omits the provided keys from the object.

Type Parameters​

T​

T extends object

K​

K extends string | number | symbol

Parameters​

obj​

T | null | undefined

keys​

readonly K[]

Returns​

Omit<T, K>