Skip to main content

Function: safeObjectOmit()

Call Signature​

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

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

Omitting keys from a nullish input yields an empty object.

Parameters​

obj​

null | undefined

keys​

readonly PropertyKey[]

Returns​

Record<string, never>

Call Signature​

function safeObjectOmit<T, K>(
    obj:
        | T
        | null
        | undefined,
    keys: readonly K[]
): {
    [
        KeyType in
            | string
            | number
            | symbol as Filter<KeyType, K>
    ]: T[KeyType];
};

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

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​

{ [KeyType in string | number | symbol as Filter<KeyType, K>]: T[KeyType] }

Call Signature​

function safeObjectOmit<T, K>(
    obj:
        | T
        | null
        | undefined,
    keys: readonly K[]
): {
    [
        KeyType in
            | string
            | number
            | symbol as Filter<KeyType, Extract<K, keyof T>>
    ]: T[KeyType];
};

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

Omits arbitrary own-property keys while preserving the known source shape.

Type Parameters​

T​

T extends object

K​

K extends PropertyKey

Parameters​

obj​

T | null | undefined

keys​

readonly K[]

Returns​

{ [KeyType in string | number | symbol as Filter<KeyType, Extract<K, keyof T>>]: T[KeyType] }