@zerodep/guard-boolean

A run-time guard to require a value to be a boolean; it will throw a ZeroDepError if the guard fails.

Full documentation is available at the zerodep.app page.

Examples

All @zerodep packages support both ESM and CJS.

import { guardBoolean } from '@zerodep/guard-boolean';
// or
const { guardBoolean } = require('@zerodep/guard-boolean');

Successful Cases

guardBoolean(true); // void
guardBoolean(false); // void

Unsuccessful Cases

guardBoolean([]); // throws ZeroDepError: Value is not a boolean
guardBoolean(['a', 'b', 'c']); // throws ZeroDepError: Value is not a boolean
guardBoolean(1000n); // throws ZeroDepError: Value is not a boolean
guardBoolean(new Date()); // throws ZeroDepError: Value is not a boolean
guardBoolean(''); // throws ZeroDepError: Value is not a boolean
guardBoolean(new Error('message')); // throws ZeroDepError: Value is not a boolean
guardBoolean(3.14); // throws ZeroDepError: Value is not a boolean
guardBoolean(() => 'function'); // throws ZeroDepError: Value is not a boolean
guardBoolean(42); // throws ZeroDepError: Value is not a boolean
guardBoolean(
  new Map([
    ['a', 1],
    ['b', 2],
  ])
); // throws ZeroDepError: Value is not a boolean
guardBoolean(null); // throws ZeroDepError: Value is not a boolean
guardBoolean({ an: 'object' }); // throws ZeroDepError: Value is not a boolean
guardBoolean(new Promise(() => {})); // throws ZeroDepError: Value is not a boolean
guardBoolean(/[regex]+/gi); // throws ZeroDepError: Value is not a boolean
guardBoolean(new Set([1, 2, 3])); // throws ZeroDepError: Value is not a boolean
guardBoolean('a string'); // throws ZeroDepError: Value is not a boolean
guardBoolean(Symbol()); // throws ZeroDepError: Value is not a boolean
guardBoolean(new Int32Array(2)); // throws ZeroDepError: Value is not a boolean
guardBoolean(undefined); // throws ZeroDepError: Value is not a boolean
``;