No Description

Sven Slootweg 97c30be23d 0.1.3 1 week ago
.eslintrc f494bf527a Initial commit 1 month ago
.gitignore f494bf527a Initial commit 1 month ago
README.md f494bf527a Initial commit 1 month ago
index.js bb96884744 Work around plain-object misdetection issue for now 1 week ago
package.json 97c30be23d 0.1.3 1 week ago
yarn.lock 295aee347e Replace flat/flatMap implementation to reduce bundle size 1 month ago

README.md

@validatem/normalize-rules

This library implements the logic that Validatem uses internally for flattening and normalizing a list of rules (validators and combinators), prior to applying them.

It's particularly useful if you're writing a combinator that does some sort of preprocessing on rules before applying them, and you need the same flattening/normalization logic that @validatem/core uses.

Please see the Validatem website for full documentation on how this package fits into the ecosystem of utility and internals packages. This README only includes the API docunentation.

Why is this a separate package?

One of the design goals of Validatem is to minimize how much complexity and code you're adding to your project. Because of that, all of the plumbing used by validators and combinators is packaged as granularly as possible. This prevents the situation where you have 20 copies of the entire Validatem core floating around in your project, just because different validators happen to depend on slightly different versions.

By having several small 'plumbing' packages, validators never need to depend on @validatem/core, but only on the specific bits of plumbing that they need.

License, donations, and other boilerplate

Licensed under either the WTFPL or CC0, at your choice. In practice, that means it's more or less public domain, and you can do whatever you want with it. Giving credit is not required, but still very much appreciated! I'd love to hear from you if validatem was useful to you.

Creating and maintaining open-source modules is a lot of work. A donation is also not required, but much appreciated! You can donate here.

If you are contributing to this project, keep in mind that you will also be making your contributions available under the above licenses.

API

normalizeRules(rules, [options])

Takes a list of rules and returns a single, normalized, flattened array of rules.

  • rules: The list of rules to normalize. Note that multiple formats are accepted:
    • A single validator/combinator, without any array wrapping.
    • A flat array of validators/combinators.
    • An arbitrarily nested array of (arrays of arrays of ...) validators/combinators, which will be flattened.
  • options: Optional. An object of options.
    • normalizeObjects: Whether to turn object literals into @validatem/has-shape combinators, like Validatem does internally. If you want to pre-process object-literal rules, you probably want to keep this turned off. Defaults to false.