@the-/scope

State scope for the-store

Installation

$ npm install @the-/scope --save

Usage

'use strict'

const { TheScope } = require('@the-/scope')
const { TheStore } = require('@the-/store')

async function tryExample() {
  class FlgScope extends TheScope {
    static get initialState() {
      return false
    }

    static get reducerFactories() {
      return {
        toggle(value) {
          return (state) => (typeof value === 'undefined' ? !state : value)
        },
      }
    }
  }

  const store = new TheStore()
  store.load(FlgScope, 'flg')
  store.flg.toggle(true)
  console.log(store.flg.state) // -> true
}

tryExample().catch((err) => console.error(err))

API Guide

• BooleanScope
  • #false()
  • #set()
  • #true()
• module:@the-/scope
  • .create(args)
  • .default()
  • .scopes
  • .TheScope
• module:@the-/scope.scopes
  • .ArrayScope
  • .BooleanScope
  • .NullScope
  • .NumberScope
  • .ObjectScope
  • .Scope
  • .ScopeScope
  • .StringScope
  • .ValueScope
• module:@the-/scope.scopes.ArrayScope
  • #concat(values)
  • #pop()
  • #push(entry)
  • #reset(values)
  • #set(index,entry)
  • #shift()
  • #unshift(entry)
• module:@the-/scope.scopes.BooleanScope
  • #toggle(value)
• module:@the-/scope.scopes.NullScope
  • #init()
• module:@the-/scope.scopes.NumberScope
  • #decrement(amount)
  • #increment(amount)
  • #set(n)
• module:@the-/scope.scopes.ObjectScope
  • #del(names)
  • #drop()
  • #reset(values)
  • #set(name,value)
• module:@the-/scope.scopes.StringScope
  • #del()
  • #replace(from,to)
  • #set(value)
• module:@the-/scope.scopes.ValueScope
  • #del()
  • #set(value)
• NumberScope
  • #isNegative()
  • #isPositive()
  • #isZero()
• ObjectScope
  • #get()
  • #has()
• Scope
  • .withDefault()
• ScopeScope
  • #get(namepath)
  • #has(namepath)
  • #init(names)
  • #of(namepath)
  • #set(namepath,value)

See API Guide for more detail

License

This software is released under the MIT License.

Links

• THE Labo