Overriding Default Values

Overriding Options Globally

You can customize the default validation options globally using the v.configure() method. This method accepts an object where you can specify the options you want to override. Here's how you can do it:

v.configure({
  validatorOptions: { dev: true },
  regex: { EMAIL: /pattern/ },
  local: 'en'
})

In the configuration object:

• validatorOptions: This property allows you to specify various options for validators. If you don't provide this property, the default options will be used.
• regex: You can override or define custom regex patterns for specific validation rules.
• local: This property sets the locale to be used for validation messages.

Here are the options that you can override:

By customizing these options, you can tailor the validation behavior according to your application's specific requirements.

Overriding Options For A Specific Validator

While you can set global options using v.configure(), sometimes you may need to customize options for a specific validator instance. This allows you to fine-tune validation behavior according to the unique requirements of each validator.

To override default options for a specific validator, provide the options property in the validator object during its creation.

Here's an example:

const userValidator = v.validator<User>({
  id: "userValidator",
  items: {
    username: v.string().required(),
    password: v.string().required()
  },
  options: { // Customize options for this validator instance
    dev: true,
    resultsType: "object",
  }
})

In this example:

• The dev option is set to true, enabling development mode for this validator instance. This provides additional debugging information.
• The resultsType option is set to "object", defining the format of the validation results for this validator as an object.

By overriding options for specific validators, you can precisely control their behavior to meet your application's requirements. This allows for greater flexibility and customization in validation logic.

Overriding Regex Values

This library provides the flexibility to override default regex values used for validating string data, such as email addresses, phone numbers, URLs, and more. You can customize these regex patterns to better suit your specific validation requirements.

Using v.configure() Method:

You can override default regex values globally by using the v.configure() method. Provide the desired regex patterns within the regex property of the configuration object.

v.configure({
  validatorOptions: {/**/},
  regex: {
    EMAIL: /email@[a-z]+\.[a-z]+/i,
    PHONE: /\+\d{1,3}\(\d{3}\)\d{3}-\d{4}/,
    // Add or override other regex values as needed
  }
})

Directly in v.regex Container:

Alternatively, you can directly modify the v.regex container to override default regex values. This method offers more flexibility and control over individual regex patterns.

v.regex.EMAIL = /email@[a-z]+\.[a-z]+/i
v.regex.PHONE = /\+\d{1,3}\(\d{3}\)\d{3}-\d{4}/
// Add or override other regex values as needed

Default Regex Patterns:

Here are the default regex patterns used for various validations:

Feel free to modify these regex patterns according to your specific validation needs.

Overriding Localization

Localization is essential for providing error messages and validation feedback in different languages or cultural contexts. This feature allows you to customize the language used for validation messages, making your application more accessible to users from diverse backgrounds.

1. Using v.configure() Method: When using v.configure(), you can specify the desired locale directly in the configuration object. This will set the default language for all validation messages generated by the library.

   v.configure({
     validatorOptions: {/**/},
     regex: {/**/},
     local: "ar" // Set the default locale to Arabic
   })

2. Using m.changeLocal() API: Alternatively, you can dynamically change the locale at runtime using the m.changeLocal() method provided by the library. This allows you to switch languages based on user preferences or application settings.

   m.changeLocal("ar") // Change the locale to Arabic

By overriding the localization settings, you can ensure that validation messages are displayed in the appropriate language for your users. This enhances the user experience and helps improve accessibility for a global audience.