readme.md

boolean

Back to root readme.md

This function uses the rulr.isBoolean guard to check the input is a boolean as shown in the example below. It should only throw rulr.InvalidBooleanError.

import * as rulr from 'rulr'

const constrainToExample = rulr.object({
	required: {
		example: rulr.boolean,
	},
})

type Example = rulr.Static<typeof constrainToExample>
// {
//   example: boolean
// }

// Valid
const example1: Example = constrainToExample({
	example: true,
})

// Invalid
const example2: Example = constrainToExample({
	example: 1,
})