isBoolean

isBoolean is a type guard that lets Typescript know that the variable passed in is a boolean.

Parameters

candidate: unknown

Supply any variable to test if it’s a boolean or not.

Returns

A type predicate for a boolean (candidate is boolean).

Examples

import { isBoolean } from '@revolutionarygamesco/common'

isBoolean(true) // true
isBoolean(false) // true
isBoolean(1 + 1 === 2) // true
isBoolean('true') // false
isBoolean(0) // false
isBoolean({ a: true }) // false