strictObject

Creates a strict object schema.

const Schema = v.strictObject<TEntries, TMessage>(entries, message);

Generics

• TEntries extends ObjectEntries
• TMessage extends ErrorMessage<StrictObjectIssue> | undefined

Parameters

• entries TEntries
• message TMessage

Explanation

With strictObject you can validate the data type of the input and whether the content matches entries. If the input is not an object or does include unknown entries, you can use message to customize the error message.

The difference to object is that this schema returns an issue for unknown entries. It intentionally returns only one issue. Otherwise, attackers could send large objects to exhaust device resources. If you want an issue for every unknown key, use the objectWithRest schema with never for the rest argument.

This schema does not distinguish between missing and undefined entries. The reason for this decision is that it reduces the bundle size, and we also expect that most users will expect this behavior.

Returns

• Schema StrictObjectSchema<TEntries, TMessage>

Examples

The following examples show how strictObject can be used. Please see the object guide for more examples and explanations.

Simple object schema

Schema to validate a strict object with two keys.

const SimpleObjectSchema = v.strictObject({
  key1: v.string(),
  key2: v.number(),
});

Merge several objects

Schema that merges the entries of two object schemas.

const MergedObjectSchema = v.strictObject({
  ...ObjectSchema1.entries,
  ...ObjectSchema2.entries,
});

Mark keys as optional

Schema to validate an object with partial entries.

const PartialObjectSchema = v.partial(
  v.strictObject({
    key1: v.string(),
    key2: v.number(),
  })
);

Object with selected entries

Schema to validate only selected entries of a strict object.

const PickObjectSchema = v.pick(
  v.strictObject({
    key1: v.string(),
    key2: v.number(),
    key3: v.boolean(),
  }),
  ['key1', 'key3']
);

Related

The following APIs can be combined with strictObject.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• custom,
• date,
• enum,
• file,
• function,
• instance,
• intersect,
• lazy,
• literal,
• looseObject,
• looseTuple,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null,
• nullable,
• nullish,
• number,
• object,
• objectWithRest,
• optional,
• picklist,
• promise,
• record,
• set,
• strictTuple,
• string,
• symbol,
• tuple,
• tupleWithRest,
• undefined,
• undefinedable,
• union,
• unknown,
• variant,
• void

Methods

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

Actions

• check,
• brand,
• description,
• metadata,
• partialCheck,
• rawCheck,
• rawTransform,
• readonly,
• title,
• transform

Utils

• entriesFromList,
• isOfKind,
• isOfType