objectAsync

Creates an object schema.

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

Generics

• TEntries extends ObjectEntriesAsync
• TMessage extends ErrorMessage<ObjectIssue> | undefined

Parameters

• entries TEntries
• message TMessage

Explanation

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

This schema removes unknown entries. The output will only include the entries you specify. To include unknown entries, use looseObjectAsync. To return an issue for unknown entries, use strictObjectAsync. To include and validate unknown entries, use objectWithRestAsync.

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 ObjectSchemaAsync<TEntries, TMessage>

Examples

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

New user schema

Schema to validate an object containing new user details.

import { isEmailPresent } from '~/api';

const NewUserSchema = v.objectAsync({
  firstName: v.pipe(v.string(), v.minLength(2), v.maxLength(45)),
  lastName: v.pipe(v.string(), v.minLength(2), v.maxLength(45)),
  email: v.pipeAsync(
    v.string(),
    v.email(),
    v.checkAsync(isEmailPresent, 'The email is already in use by another user.')
  ),
  password: v.pipe(v.string(), v.minLength(8)),
  avatar: v.optional(v.pipe(v.string(), v.url())),
});

Related

The following APIs can be combined with objectAsync.

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,
• objectWithRest,
• optional,
• picklist,
• promise,
• record,
• set,
• strictObject,
• strictTuple,
• string,
• symbol,
• tuple,
• tupleWithRest,
• undefined,
• union,
• unknown,
• variant,
• void

Methods

• config,
• getDefault,
• getFallback,
• keyof,
• omit,
• pick

Actions

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

Utils

• entriesFromList,
• isOfKind,
• isOfType

Async

• arrayAsync,
• checkAsync,
• customAsync,
• fallbackAsync,
• forwardAsync,
• getDefaultsAsync,
• getFallbacksAsync,
• intersectAsync,
• lazyAsync,
• looseObjectAsync,
• looseTupleAsync,
• mapAsync,
• nonNullableAsync,
• nonNullishAsync,
• nonOptionalAsync,
• nullableAsync,
• nullishAsync,
• objectWithRestAsync,
• optionalAsync,
• parseAsync,
• parserAsync,
• partialAsync,
• partialCheckAsync,
• pipeAsync,
• rawCheckAsync,
• rawTransformAsync,
• recordAsync,
• requiredAsync,
• safeParseAsync,
• safeParserAsync,
• setAsync,
• strictObjectAsync,
• strictTupleAsync,
• transformAsync,
• tupleAsync,
• tupleWithRestAsync,
• unionAsync,
• variantAsync