notRequired() with empty string causes validation to fail

Explanation of the problem

Troubleshooting with the Lightrun Developer Observability Platform

Getting a sense of what’s actually happening inside a live application is a frustrating experience, one that relies mostly on querying and observing whatever logs were written during development.
Lightrun is a Developer Observability Platform, allowing developers to add telemetry to live applications in real-time, on-demand, and right from the IDE.

• Instantly add logs to, set metrics in, and take snapshots of live applications
• Insights delivered straight to your IDE or CLI
• Works where you do: dev, QA, staging, CI/CD, and production

Start for free today

Problem solution for notRequired() with empty string causes validation to fail

Problem: inability to validate phone numbers in specific formats

One common problem encountered when using the yup-phone library is the inability to validate phone numbers in specific formats or regions. The yup-phone library is designed to handle phone number validation within the Yup validation schema. However, it may not support all the desired formats or regions out of the box. This can be problematic when dealing with international phone numbers or when specific formatting requirements need to be enforced. Developers may find that the default validation rules provided by yup-phone do not meet their specific needs.

Solution:

To address this issue, developers can extend the functionality of yup-phone by incorporating custom validation logic into their Yup validation schema. By utilizing Yup’s test method, developers can define a custom validation function that performs the desired phone number validation based on their specific format or region requirements. This allows for greater flexibility in validating phone numbers and ensures that the validation meets the desired criteria. The custom validation function can handle complex formatting rules, country codes, or any other custom validation logic required by the application.

Problem: non-standard or unconventional formats

Another common problem with yup-phone arises when attempting to validate phone numbers in non-standard or unconventional formats. The library may have limitations in handling phone numbers that deviate from standard formats, such as including additional characters, symbols, or spaces. In such cases, the default validation rules provided by yup-phone may not be sufficient to handle the unconventional phone number formats, leading to validation errors or false negatives.

Solution:

To overcome this problem, developers can again leverage Yup’s test method to implement custom validation rules for non-standard phone number formats. By defining a custom validation function within the validation schema, developers can accommodate unconventional phone number formats and validate them accordingly. The custom function can strip out unwanted characters, normalize the format, or apply any other necessary transformations to ensure accurate validation. This approach allows for a more robust and flexible validation process, accommodating various phone number formats beyond the standard ones supported by yup-phone.

Problem: lack of support

One more issue that developers may encounter with yup-phone is the lack of support for phone number input masks or formatting during user input. Input masks are useful for guiding users to enter phone numbers in a specific format by automatically adding separators or placeholders. While yup-phone focuses on validation rather than input formatting, developers may find it challenging to integrate input masks or enforce a specific phone number format during user input.

Solution:

A brief introduction to yup-phone

Most popular use cases for Class Validator

1. Phone Number Validation: The primary use of yup-phone is to provide phone number validation capabilities within the Yup validation schema. It allows developers to define and enforce validation rules for phone numbers in their applications. By utilizing the library’s built-in methods and validation rules, developers can ensure that phone numbers entered by users conform to specific formats and meet the required criteria. Here’s an example of how yup-phone can be used to validate a phone number in a Yup schema:

const schema = yup.object().shape({
  phoneNumber: yup.string().phone('US', true, 'Invalid phone number'),
});

// Usage:
const data = { phoneNumber: '+1 123-456-7890' };
schema.validate(data)
  .then(validatedData => {
    // Validation passed
  })
  .catch(error => {
    // Validation failed
    console.error(error);
  });