config

Changes the local configuration of a schema.

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

Generics

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

Parameters

• schema TSchema
• config Config<InferIssue<TSchema>>

Explanation

This method overwrites the selected configuration properties by merging the previous configuration of the schema with the provided config.

Returns

• Schema TSchema

Examples

The following examples show how config can be used.

Same error message

Schema that uses the same error message for the entire pipeline.

const Schema = v.object({
  email: v.config(
    v.pipe(v.string(), v.trim(), v.email(), v.endsWith('@example.com')),
    { message: 'The email does not conform to the required format.' }
  ),
  // ...
});

Abort pipeline early

Schema that aborts only a specific pipeline early.

const Schema = v.object({
  url: v.config(
    v.pipe(v.string(), v.trim(), v.url(), v.endsWith('@example.com')),
    { abortPipeEarly: true }
  ),
  // ...
});

Related

The following APIs can be combined with config.

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,
• strictObject,
• strictTuple,
• string,
• symbol,
• tuple,
• tupleWithRest,
• undefined,
• union,
• unknown,
• variant,
• void

Methods

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

Actions

• bic,
• brand,
• bytes,
• check,
• checkItems,
• creditCard,
• cuid2,
• decimal,
• email,
• emoji,
• empty,
• endsWith,
• everyItem,
• excludes,
• filterItems,
• findItem,
• finite,
• hash,
• hexadecimal,
• hexColor,
• imei,
• includes,
• integer,
• ip,
• ipv4,
• ipv6,
• isoDate,
• isoDateTime,
• isoTime,
• isoTimeSecond,
• isoTimestamp,
• isoWeek,
• length,
• mac,
• mac48,
• mac64,
• mapItems,
• maxBytes,
• maxLength,
• maxSize,
• maxValue,
• mimeType,
• minBytes,
• minLength,
• minSize,
• minValue,
• multipleOf,
• nonEmpty,
• notBytes,
• notLength,
• notSize,
• notValue,
• octal,
• partialCheck,
• rawCheck,
• rawTransform,
• readonly,
• reduceItems,
• regex,
• safeInteger,
• size,
• someItem,
• sortItem,
• startsWith,
• toLowerCase,
• toMaxValue,
• toMinValue,
• toUpperCase,
• transform,
• trim,
• trimEnd,
• trimStart,
• ulid,
• url,
• uuid,
• value