message

Changes the local message configuration of a schema.

const Schema = v.message<TSchema>(schema, message_);

Generics

• TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>

Parameters

• schema TSchema
• message_ ErrorMessage<InferIssue<TSchema>>

Explanation

This method overrides the local message configuration of the schema. In practice, it is typically used to specify a single error message for an entire pipeline.

Returns

• Schema TSchema

Examples

The following examples show how message can be used.

Email schema

Email schema that uses the same error message for the entire pipeline.

const EmailSchema = v.message(
  v.pipe(v.string(), v.trim(), v.nonEmpty(), v.email(), v.maxLength(100)),
  'The email is not in the required format.'
);

Related

The following APIs can be combined with message.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• custom,
• date,
• enum,
• exactOptional,
• 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,
• strictObject,
• strictTuple,
• string,
• symbol,
• tuple,
• tupleWithRest,
• undefined,
• undefinedable,
• union,
• unknown,
• variant,
• void

Methods

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

Actions

• args,
• base64,
• bic,
• brand,
• bytes,
• check,
• checkItems,
• creditCard,
• cuid2,
• decimal,
• description,
• digits,
• email,
• emoji,
• empty,
• endsWith,
• everyItem,
• excludes,
• filterItems,
• findItem,
• finite,
• graphemes,
• gtValue,
• hash,
• hexadecimal,
• hexColor,
• imei,
• includes,
• integer,
• ip,
• ipv4,
• ipv6,
• isoDate,
• isoDateTime,
• isoTime,
• isoTimeSecond,
• isoTimestamp,
• isoWeek,
• length,
• ltValue,
• mac,
• mac48,
• mac64,
• mapItems,
• maxBytes,
• maxGraphemes,
• maxLength,
• maxProps,
• maxSize,
• maxValue,
• maxWords,
• metadata,
• mimeType,
• minBytes,
• minGraphemes,
• minLength,
• minProps,
• minSize,
• minValue,
• minWords,
• multipleOf,
• nanoid,
• nonEmpty,
• notBytes,
• notGraphemes,
• notLength,
• notSize,
• notValue,
• notValues,
• notWords,
• octal,
• partialCheck,
• rawCheck,
• rawTransform,
• readonly,
• reduceItems,
• regex,
• returns,
• rfcEmail,
• safeInteger,
• size,
• slug,
• someItem,
• sortItem,
• startsWith,
• title,
• toLowerCase,
• toMaxValue,
• toMinValue,
• toUpperCase,
• transform,
• trim,
• trimEnd,
• trimStart,
• ulid,
• url,
• uuid,
• value,
• values,
• words

Utils

• isOfKind,
• isOfType

Async

• arrayAsync,
• customAsync,
• exactOptionalAsync,
• fallbackAsync,
• intersectAsync,
• lazyAsync,
• looseObjectAsync,
• looseTupleAsync,
• mapAsync,
• nonNullableAsync,
• nonNullishAsync,
• nonOptionalAsync,
• nullableAsync,
• nullishAsync,
• objectAsync,
• objectWithRestAsync,
• optionalAsync,
• partialAsync,
• pipeAsync,
• recordAsync,
• requiredAsync,
• setAsync,
• strictObjectAsync,
• strictTupleAsync,
• tupleAsync,
• tupleWithRestAsync,
• unionAsync,
• variantAsync