BooleanStoreclass

new BooleanStore(value: boolean = false)
ParamType
valueboolean
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

ts
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

Methods

Go

BooleanStore.toggle()method

Toggle the current boolean value.

toggle(): void