Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ryasmi/rulr

📐 Validation and unit conversion errors in TypeScript at compile-time. Started in 2016. Publicised in 2020.
https://github.com/ryasmi/rulr

javascript sanitization typescript unit-conversion validation

Last synced: about 19 hours ago
JSON representation

📐 Validation and unit conversion errors in TypeScript at compile-time. Started in 2016. Publicised in 2020.

Host: GitHub
URL: https://github.com/ryasmi/rulr
Owner: ryasmi
License: mit
Created: 2016-12-12T23:27:48.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2025-01-27T18:40:50.000Z (8 days ago)
Last Synced: 2025-01-27T19:48:22.295Z (8 days ago)
Topics: javascript, sanitization, typescript, unit-conversion, validation
Language: TypeScript
Homepage: https://www.npmjs.com/package/rulr
Size: 10.6 MB
Stars: 46
Watchers: 3
Forks: 3
Open Issues: 8
Metadata Files:
- Readme: readme.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        


  📐rulr

	Validation and unit conversion errors in TypeScript at compile-time.

	

	

	

	

	

	

	



```ts

// Install it with `npm i rulr`

import * as rulr from 'rulr'

// Compile-time error.

const positiveNumber1: rulr.PositiveNumber = -1

// Run-time error.

const positiveNumber2 = rulr.positiveNumber(-1)

// Convenient rules and guards like `object`.

const example = rulr.object({

	required: {

		price: rulr.positiveNumber,

	},

})

// Turn rules into types to avoid duplicating information.

type Example = rulr.Static

// Turn rules into guards to avoid duplicating code.

const isExample = rulr.guard(example)

// Use rules and/or guards to guarantee your data is valid.

const myExample: Example = example({ price: 12.34 })

if (isExample(myExample)) {

	console.log(myExample.price)

}

```

### Getting Started ✨

To save you some time, Rulr comes with the following rules.

- [allowNull](./src/higherOrderRules/allowNull/readme.md)

- [allowUndefined](./src/higherOrderRules/allowUndefined/readme.md)

- [any](./src/valueRules/any/readme.md)

- [array](./src/higherOrderRules/array/readme.md)

- [bigint](./src/valueRules/bigint/readme.md)

- [boolean](./src/valueRules/boolean/readme.md)

  - [trueRule](./src/valueRules/trueRule/readme.md)

  - [falseRule](./src/valueRules/falseRule/readme.md)

- [constant](./src/valueRules/constant/readme.md)

- [date](./src/valueRules/date/readme.md)

- [dictionary](./src/higherOrderRules/dictionary/readme.md)

- [enum](./src/valueRules/enum/readme.md)

- [literal](./src/valueRules/literal/readme.md)

- [number](./src/valueRules/number/readme.md)

- [object](./src/higherOrderRules/object/readme.md)

- [string](./src/valueRules/string/readme.md)

- [symbol](./src/valueRules/symbol/readme.md)

- [tuple](./src/higherOrderRules/tuple/readme.md)

- [union](./src/higherOrderRules/union/readme.md)

- [unknown](./src/valueRules/unknown/readme.md)

### Sized Strings

Since it's quite common to want to restrict the size of strings to avoid UI overflow bugs and DB storage errors, Rulr comes with some convenient rules for doing just that.

- [nonEmptyString](./src/sizedStrings/nonEmptyString/readme.md)

- [tinyText](./src/sizedStrings/tinyText/readme.md) (0 - 255 characters)

- [text](./src/sizedStrings/text/readme.md) (0 - 65,535 characters)

- [mediumText](./src/sizedStrings/mediumText/readme.md) (0 - 16,777,215 characters)

### Constraining Strings

Rulr comes with a growing list of convenient rules for constraining strings that are mostly built on [Chris O'Hara's extensive and much loved validator package](https://www.npmjs.com/package/validator). As with the rules for sized strings above, this can help prevent UI overflow bugs, DB storage errors, and processing errors.

- [email](./src/constrainedStrings/email/readme.md)

- [iri](./src/constrainedStrings/iri/readme.md)

- [iso8601Duration](./src/constrainedStrings/iso8601Duration/readme.md)

- [iso8601FullDate](./src/constrainedStrings/iso8601FullDate/readme.md)

- [iso8601Timestamp](./src/constrainedStrings/iso8601Timestamp/readme.md)

- [locale](./src/constrainedStrings/locale/readme.md)

- [mailto](./src/constrainedStrings/mailto/readme.md)

- [mimeType](./src/constrainedStrings/mimeType/readme.md)

- [mongoId](./src/constrainedStrings/mongoId/readme.md)

- [scormInteractionType](./src/constrainedStrings/scormInteractionType/readme.md)

- [semanticVersion](./src/constrainedStrings/semanticVersion/readme.md)

- [sha1](./src/constrainedStrings/sha1/readme.md)

- [url](./src/constrainedStrings/url/readme.md)

- [uuidv4](./src/constrainedStrings/uuidv4/readme.md)

### Constraining Non-Strings

In addition to the constrained strings, Rulr comes with a few convenient rules to help you quickly validate non-string values.

- [integer](./src/constrainedValues/integer/readme.md)

- [negativeInteger](./src/constrainedValues/negativeInteger/readme.md)

- [negativeNumber](./src/constrainedValues/negativeNumber/readme.md)

- [positiveInteger](./src/constrainedValues/positiveInteger/readme.md)

- [positiveNumber](./src/constrainedValues/positiveNumber/readme.md)

### Sanitization Rules

Rulr provides rules that sanitize inputs from HTTP headers and URL params.

- [sanitizeBooleanFromString](./src/sanitizationRules/sanitizeBooleanFromString/readme.md)

- [sanitizeJsonFromString](./src/sanitizationRules/sanitizeJsonFromString/readme.md)

- [sanitizeNumberFromString](./src/sanitizationRules/sanitizeNumberFromString/readme.md)

- [sanitizeBasicAuthFromString](./src/sanitizationRules/sanitizeBasicAuthFromString/readme.md)

- [sanitizeJWTBearerAuthFromString](./src/sanitizationRules/sanitizeJWTBearerAuthFromString/readme.md)

### Rule Constructors

Finally, Rulr is starting to provide rule constructors that allow you quickly make your own rules.

- [regexRuleConstructor](./src/ruleConstructors/regexRuleConstructor/readme.md)

- [sizedArrayRuleConstructor](./src/ruleConstructors/sizedArrayRuleConstructor/readme.md)

### Frequently Awesome Questions 🤘

- [How does Rulr protect against unit conversion errors?](./docs/unitConversionErrorProtection.md)

- [How do I create my own rules?](./docs/customRules.md)

- [Can I add new rules to this package?](./docs/newRules.md)

- [Why not use classes?](./docs/classValidationProblems.md)

- [Why are unique symbols needed for each type?](./docs/symbolRequirement.md)

- [How are recursive rules defined?](./docs/recursiveRules.md)

- [Can Rulr be used with React Hooks and PropTypes?](./docs/react.md)

- [Can Rulr be used with Express?](./docs/express.md)

- [Why are you using tabs!?!](https://www.reddit.com/r/javascript/comments/c8drjo/nobody_talks_about_the_real_reason_to_use_tabs/)

- [Why is the bundle size quite large?](https://bundlephobia.com/result?p=rulr)

- [How does the performance compare to other validation packages?](https://github.com/moltar/typescript-runtime-type-benchmarks)

- [How often are breaking changes/major version bumps released?](./docs/breakingChangeFrequency.md)

### Background

Rulr was started in 2016 and [first publicised in 2020](https://www.reddit.com/r/typescript/comments/hb1nt6/rulr_typescript_package_to_save_you_time_writing/). It continues to be maintained to save us time writing validation logic and correcting data by returning as many validation errors as possible in one function call.

Rulr has been influenced by [Tom Crockett in RunTypes](https://github.com/pelotom/runtypes) and more recently [Colin McDonnell in Zod](https://github.com/vriad/zod). It's hoped that if nothing else, publicising Rulr will influence existing and future validation packages for the better.