BooleanStoreclass

new BooleanStore(value: boolean = false)

Param	Type
`value`	`boolean`	The initial boolean value (defaults to `false`). Defaults to `false`

Return
`BooleanStore`	Store a boolean value.

Store a boolean value.

Any input is coerced to a boolean via !!input, so truthy/falsy values are accepted.
Defaults to false.

A Store for a boolean value. BooleanStore defaults to false, coerces any assigned value to a boolean, and adds a .toggle() helper.

Usage

import { BooleanStore } from "shelving/store";

const open = new BooleanStore(); // defaults to false

open.toggle();        // true
open.value = 0;       // false — assigned values are coerced to boolean
console.log(open.value); // false

Examples

const store = new BooleanStore();
store.value = 1; // true (coerced)
store.toggle(); // now false

Methods

BooleanStore.toggle()method

Toggle the current boolean value.

toggle(): void