omit - API reference

API reference › @evolu/common › Type › omit

function omit<Props, Keys, Rest>(
  objectType: ObjectType<Props, Rest>,
  ...keys: Keys & [ValidateOmitKeys<Keys>] extends [never]
    ? unknown
    : readonly [ValidationFailure<ValidateOmitKeys<Keys>>]
): ObjectType<Omit<Props, Keys[number]>, Rest>;

Defined in: packages/common/src/Type.ts:11662

Object Type without the selected declared properties.

Example

import { assertOk, String, object, omit } from "@evolu/common";

const User = object({ name: String, password: String });
const PublicUser = omit(User, "password");

assertOk(PublicUser.fromUnknown({ name: "Ada" }), { name: "Ada" });