(input: unknown): input is booleanChecks whether a value is a boolean.
When to use
Use to validate unknown input and narrow it to boolean.
Example (Checking for booleans)
import { Boolean } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Boolean.isBoolean(true), true)
assert.deepStrictEqual(Boolean.isBoolean("true"), false)guards
Source effect/Boolean.ts:721 lines
export const const isBoolean: (
input: unknown
) => input is boolean
Checks whether a value is a boolean.
When to use
Use to validate unknown input and narrow it to boolean.
Example (Checking for booleans)
import { Boolean } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Boolean.isBoolean(true), true)
assert.deepStrictEqual(Boolean.isBoolean("true"), false)
isBoolean: (input: unknowninput: unknown) => input: unknowninput is boolean = import predicatepredicate.function isBoolean(
input: unknown
): input is boolean
Checks whether a value is a boolean.
When to use
Use when you need a Predicate guard to narrow an unknown value to a
boolean.
Details
Uses typeof input === "boolean".
Example (Guarding booleans)
import { Predicate } from "effect"
const data: unknown = true
if (Predicate.isBoolean(data)) {
console.log(data ? "yes" : "no")
}
isBoolean