search

tgriesser / checkit

simple, flexible validations for node and the browser
MIT License
223 stars 53 forks source link

Better documentation #51

Open doliver3 opened 8 years ago

doliver3 commented 8 years ago

Could you better document this?

For example, there is no explanation nor is there a test case showing how to do a custom Regex validation.

When the words 'value must be a valid Regex' is used, where is the RegEx defined to pass to CheckIt?

It is very unclear what the arguments are and what the expected usage of the API is.

rhys-vdw commented 8 years ago

Hi @doliver3. Unfortunately I don't know the answer to this one. I'll happily accept a PR if you are willing to investigate and update documentation.

NinjaBanjo commented 8 years ago

@doliver3 Checkit doesn't support Regex directly, it is only doing a typeof check when you use it currently. you would have to make a custom validator to check if valid regex yourself.

kvedantmahajan commented 6 years ago

How about a clear explanation via webpack as mentioned. The links just takes to webpack site. I hope you are not expecting people to learn webpack first and then use checkit.

Also, it's not clear if it should work via npm install checkit or not.

If not then what issues may user run should be mentioned.