required

Creates a modified copy of an object schema that marks all entries or only the selected keys as required.

const Schema = v.required<TSchema>(schema, message);
const Schema = v.required<TSchema, TKeys>(schema, keys, message);

Generics

• TSchema extends LooseObjectSchema<ObjectEntries, ErrorMessage<ObjectIssue> | undefined> | ObjectSchema<ObjectEntries, ErrorMessage<ObjectIssue> | undefined> | ObjectWithRestSchema<ObjectEntries, BaseSchema<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<ObjectWithRestIssue> | undefined> | StrictObjectSchema<ObjectEntries, ErrorMessage<ObjectIssue> | undefined>
• TKeys extends ObjectKeys<TSchema> | undefined

Parameters

• schema TSchema
• keys TKey
• message ErrorMessage<NonOptionalIssue> | undefined

Explanation

required creates a modified copy of the given object schema where all entries or only the selected keys are required. It is similar to TypeScript's Required utility type.

Because required changes the data type of the input and output, it is not allowed to pass a schema that has been modified by the pipe method, as this may cause runtime errors. Please use the pipe method after you have modified the schema with required.

Returns

• Schema SchemaWithRequired<TSchema, TKeys>

Examples

The following examples show how required can be used.

Required object schema

Schema to validate an object with required entries.

const RequiredSchema = v.required(
  v.object({
    key1: v.optional(v.string()),
    key2: v.optional(v.number()),
  })
); // { key1: string; key2: number }

With only specific keys

Schema to validate an object with only specific entries marked as required.

const RequiredSchema = v.required(
  v.object({
    key1: v.optional(v.string()),
    key2: v.optional(v.number()),
    key3: v.optional(v.boolean()),
  }),
  ['key1', 'key3']
); // { key1: string; key2?: number; key3: boolean }

Related

The following APIs can be combined with required.

Schemas

• array,
• intersect,
• lazy,
• looseObject,
• looseTuple,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• objectWithRest,
• optional,
• record,
• set,
• strictObject,
• strictTuple,
• tuple,
• tupleWithRest,
• union

Methods

• config,
• fallback,
• forward,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• omit,
• keyof,
• parse,
• parser,
• partial,
• pick,
• safeParse,
• safeParser,
• unwrap

Actions

• check,
• brand,
• partialCheck,
• rawCheck,
• rawTransform,
• readonly,
• transform

Utils

• isOfKind,
• isOfType