keyof

Creates a picklist schema of object keys.

const Schema = keyof<TSchema>(schema);

Generics

Parameters

  • schema TSchema

Returns

  • Schema PicklistSchema<TupleOrNever<UnionToTuple<keyof TSchema['entries']>>>

Examples

The following examples show how keyof can be used.

Object key schema

Schema to validate the keys of an object.

const ObjectSchema = object({ key1: string(), key2: number() });
const ObjectKeySchema = keyof(ObjectSchema); // 'key1' | 'key2'

The following APIs can be combined with keyof.

Schemas

Methods

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of ivan-mihalic
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper