Option to return errors instead of throwing them for performant validation. about runtypes

[yuhr]

What you want is something like below, right?

const unknown: unknown = ...

// May throw, as usual
const value: Static<typeof SomeRuntype> = SomeRuntype.check(unknown)

// New API that returns instead of throws
const value: Static<typeof SomeRuntype> | ValidationError = SomeRuntype.test(unknown)

[joshi-4]

Yes, another way could be to return array of two values i.e [SomeRunType value, ValidationError]. Is this part of some upcoming release?
Thanks, for the quick response.

[yuhr]

My bad, I forgot that there's validate API available already:

const result: Result<typeof SomeRuntype> = SomeRuntype.validate(unknown)

if (result.success) ...

We're sorry this is undocumented, but the shape of the result object is defined here in the code:

https://github.com/pelotom/runtypes/blob/661c8aceb25d23fa14b6ca1cbffcfef8887a8b8e/src/result.ts#L78

Is this sufficient for you?

[joshi-4]

Yes, I tried it, this solves my case. Thanks