Registry

The registry stores these global validation capabilities:

locale messages
active language
format matchers
rule handlers
message template engine

These capabilities live in registry.ts and are exposed through public helper functions.

Register rules

import { registerValidateRules } from '@silver-formily/validator'

registerValidateRules({
  custom(value) {
    return value === 'silver' ? '' : 'Only silver is allowed'
  },
})

After registration, both of the following trigger it:

await validate('formily', { custom: true })

await validate('formily', {
  custom: 'Any truthy value works - the real logic lives inside the custom rule function',
})

Register formats

Formats accept strings, regular expressions, or functions.

import { registerValidateFormats } from '@silver-formily/validator'

registerValidateFormats({
  slug: /^[a-z0-9-]+$/,
  internalCode: value => typeof value === 'string' && value.startsWith('SF-'),
})

You can then use them directly:

await validate('silver-formily', 'slug')
await validate('SF-001', { format: 'internalCode' })

Locales and language switching

import {
  registerValidateLocale,
  setValidateLanguage,
} from '@silver-formily/validator'

registerValidateLocale({
  'zh-CN': {
    slug: 'Slug can only contain lowercase letters, numbers, and hyphens',
  },
})

setValidateLanguage('zh-CN')

Language matching is fuzzy on purpose. Values such as en, en-US, zh, and zh-CN can resolve to the nearest registered locale key.

Built-in locales

A set of locale messages is registered by default when the module is loaded. The following language tags are available out of the box:

en
en-US
zh
zh-CN
zh-TW
ja

These locales include error messages for common rule and format keys such as required, min, max, email, url, phone, and more.

To inspect the exact messages, the safest approach is to query the registry:

import {
  getValidateLocale,
  setValidateLanguage,
} from '@silver-formily/validator'

setValidateLanguage('zh-CN')

getValidateLocale('required')
getValidateLocale('email')

If the built-in locales are not sufficient, use registerValidateLocale to extend or override messages per language.

Read current registry state

You can also treat the registry as a query entry:

import {
  getValidateFormats,
  getValidateLanguage,
  getValidateLocale,
  getValidateRules,
} from '@silver-formily/validator'

getValidateLanguage()
getValidateLocale('required')
getValidateFormats('email')
getValidateRules('required')

Message template engine

By default, messages only apply built-in {{path.to.value}} interpolation. You can also plug in your own template engine:

import { registerValidateMessageTemplateEngine } from '@silver-formily/validator'

registerValidateMessageTemplateEngine((message, context) => {
  return String(message).replace('$title', context.title)
})

The custom engine runs before built-in {{...}} path interpolation, so both mechanisms can be combined.

Registry ​

Register rules ​

Register formats ​

Locales and language switching ​

Built-in locales ​

Read current registry state ​