or condition?

[mwskwong]

I wish to make the email field:

1. Optional, and either
2. A literal "", or
3. A valid email

For implementing (2) and (3), I used to use z.or() in Zod, is there an equivalent of that for Valibot?

[mwskwong]

OK, I guess I figered it out. union seems to do what I'm looking for.

const email = optional(
  union(
    [string([email()]), literal("")], 
    "Not a valid email"
  )
);

Note that, unlike Zod, the custom error message must associated with union() instead of email() or literal().

[mwskwong]

Thanks a lot.

IMO, the first thing that we should aim for is to complete the API reference. I will see what I can do at #287. But given the time constraint and workload, I would properly pick it up one by one by referencing existing PRs to give myself and others some flexibility.

[mwskwong]

Properly wanna pin that issue BTW. And update the title to invite contributors to contribute on the doc.

[fabian-hiller]

By the way... I think my post about your article is now one of my most popular posts on Twitter. So thanks a lot for the attention it created for the project. 🧩

[fabian-hiller]

And update the title to invite contributors to contribute on the doc.

What would you call the title?

[mwskwong]

Properly something like [Help Wanted][Documentation] Completing the API Reference.

[fabian-hiller]

Note: With v0.26.0 the behavior has changed to improve the DX. The schema must now be written as follows:

import * as v from 'valibot';

const EmailSchema = v.optional(
  v.union([v.string([v.email('Not a valid email')]), v.literal('')])
);