lforst/vali-guard

A somewhat flexible validation library that guarantees TypeScript type-safety.

vali-guard's Issues

Add validator for booleans

Utility wrappers for string validator

• Regular expressions
• Min/Max string length

Move away from tsdx

Tsdx is not updated regularily and we don't want to miss out on new features of updated packages, like for example jest.

We should eliminate dependencies on tsdx and configure a build and test setup on our own.

Todo:

• Build setup
• Test setup

Utility wrappers for numbers

• Minimum / Maximum

Consider unsafe numbers

https://joi.dev/api/?v=17.6.0#numberunsafeenabled

Add validator for "unknown" values

This validator should probably not validate its subject but provide typing support.

Add validator for arrays

• consider min/max length validation

Instanceof Validator

Expose Type to extract type from validator

Add method to object validator to reject additional fields

Add validator for concrete primitive values

Validator for functions

Add badge with link to npm

Move tests for type safety into separate test suite

Tests run incredibly slow due to the type tests (TS type checking is slow) which are not parallelized via jest.

Add comprehensive API documentation

Explore assertions

https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions

Maybe we should add .assert() function to BaseValidator?

Add way to inspect why validation failed

Because it is not possible to mix return values with user-provided type guards like this for example:

function validate<T>(subject: unknown): [subject is T, Reason] {
    //                                  ~~~~~~~~~~~~~~~~~~~~~~ - Doesn't work :(
}

I thought it would work with a mutable variable like this:

const reason: guard.Reason = {}; // has to be record i believe so references are kept

if (guard.string().validate(subject, reason)) {
    // reason might contain info like { validated: false; reason: '123 is not a string' } ?
}