NullablePartial - API reference

API reference › @evolu/common › Types › NullablePartial

type NullablePartial<
  T,
  NK extends keyof T = {
    [K in keyof T]: null extends T[K] ? K : never;
  }[keyof T],
  NP = Pick<T, Exclude<keyof T, NK>> & Partial<Pick<T, NK>>,
> = { [K in keyof NP]: NP[K] };

Defined in: packages/common/src/Types.ts:279

Makes properties optional if they accept null as a value.

For each property in T, if null is a valid value for that property, the property will be made optional in the resulting type.

Optional nullable properties

import { assertType, type NullablePartial } from "@evolu/common";

type Example = {
  required: string;
  optionalWithNull: string | null;
};

assertType<
  NullablePartial<Example>,
  {
    required: string;
    optionalWithNull?: string | null;
  }
>();