Skip to content

setMessages ​

Changes the default error texts for the whole app. Pass a whole locale or just some messages.

Signature ​

ts
function setMessages(messages: Record<string, Message>): void

Parameters ​

ParameterTypeDescription
messagesRecord<string, Message>An error code (required) or a field and code (email.required, items.*.title.required) → text or a function (params) => string. Other messages stay unchanged

Notes ​

  • It is global — call it once on startup. For the language of a single request use the messages option of validate.
  • A message passed to a rule (minLength(3, '...')) takes precedence over the global one.
  • A full custom lang file: npx tinyval lang ru — see Custom lang file.
  • You can add messages for your own error codes — see Custom rules & schemas.
  • The list of codes is in Messages & i18n.

Examples ​

Russian locale ​

ts
import { setMessages } from 'tinyval';
import ru from 'tinyval/locales/ru';

setMessages(ru);

Some texts ​

ts
setMessages({
  required: 'Please fill in',
  minLength: (p) => `At least ${p.min} characters`,
});

See also ​