reactiveOmit

testeddemo

Demo

Loading demo…

Signatures

export function reactiveOmit<T extends object, K extends keyof T>(
  obj: T,
  ...keys: Array<K | K[]>
): ReactiveOmitReturn<T, K>;

export function reactiveOmit<T extends object>(
  obj: T,
  predicate: ReactiveOmitPredicate<T>,
): ReactiveOmitReturn<T>;

Type Parameters

Textends object

Kextends keyof T

Parameters

Parameter	Type	Default	Description
`obj`	`T`	—	—
`keys`?	`Array<K \| K[] \| ReactiveOmitPredicate<T>>`	—	—

Returns

ReactiveOmitReturn<T, K>

Related Types

ReactiveOmitReturn

Resolved type of reactiveOmit: a reactive object that drops either the listed keys (Omit) or — when a predicate is used — an arbitrary subset (Partial), since the kept keys are only known at runtime.

export type ReactiveOmitReturn<
  T extends object,
  K extends keyof T | undefined = undefined,
>
  = [K] extends [undefined]
    ? Partial<T>
    : Omit<T, Extract<K, keyof T>>;

ReactiveOmitPredicate

Predicate deciding, per field, whether a key should be omitted. Return true to drop the field.

export type ReactiveOmitPredicate<T extends object>
  = (value: T[keyof T], key: keyof T) => boolean;