keyof

Creates a picklist schema of object keys.

const Schema = keyof<TSchema>(schema);

Generics

• TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>

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'

Related

The following APIs can be combined with keyof.

Schemas

• array,
• intersect,
• lazy,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• optional,
• record,
• set,
• tuple,
• union

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform,
• unwrap