// 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<typeof example>

// 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
• allowUndefined
• any
• array
• bigint
• boolean
• constant
• date
• dictionary
• enum
• literal
• number
• object
• string
• symbol
• tuple
• union
• unknown

Sized Strings

Since it's quite common to want to restrict the size of strings, Rulr comes with some convenient rules for doing just that.

• nonEmptyString
• tinyText (0 - 255 characters)
• text (0 - 65,535 characters)
• mediumText (0 - 16,777,215 characters)

Constraining Strings

Rulr also 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.

• email
• iri
• iso8601Duration
• iso8601Timestamp
• locale
• mailto
• mimeType
• mongoId
• scormInteractionType
• semanticVersion
• sha1
• url
• uuidv4

Constraining Non-Strings

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

• integer
• negativeInteger
• negativeNumber
• positiveInteger
• positiveNumber

Sanitization Rules

Finally, Rulr is starting to provide rules that sanitize inputs from HTTP headers and URL params.

• sanitizeBooleanFromString
• sanitizeJsonFromString
• sanitizeNumberFromString
• sanitizeBasicAuthFromString
• sanitizeJWTBearerAuthFromString

Frequently Awesome Questions 🤘

• How does Rulr protect against unit conversion errors?
• How do I create my own rules?
• Can I add new rules to this package?
• Why not use classes?
• Why are symbols needed?
• How are recursive rules defined?
• Can Rulr be used with React Hooks and PropTypes?
• Can Rulr be used with Express?
• Why are you using tabs!?!
• Why is the bundle size quite large?
• How does the performance compare to other validation packages?
• How often are breaking changes/major version bumps released?

Background

Rulr was started in 2016 and first publicised in 2020. 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 and more recently Colin McDonnell in Zod. It's hoped that if nothing else, publicising Rulr will influence existing and future validation packages for the better.