@swear-js/core

🍭 Swear JS

@swear-js/core

Core package of SwearJS state manager

Frameworks:

• Framework agnostic (@swear-js/core)
• React (@swear-js/react)

Demo

Demo application is runnable via npx:

• [Framework agnostic] $ npx swear-demo-agnostic

Don't forget to remove created project directory after

Features

• 🍥 Simple abstraction. No need to get into FLUX, life cycle, the flow. You just have a state, and have functions(actions) that somehow mutates that state. Just like React's useState. No way simpler.
• 🍩 Deep type inferences. No need to guess what type you're working with(hey, Redux)!
• 🍡 Code splitting. Your swears can lay wherever you want. Even in the scope of another microapplication.
• 🧊 Framework-agnostic. If your framework has no support, or you just simply don't use one, core package is for you.
• 🪡 Small size. 584B
• 🐞 Logging. Store has default support for logging. And SwearJS has it's our own beautiful logger

Installation

$ npm install @swear-js/core

or in case you are using Yarn:

$ yarn add @swear-js/core

Usage

First you have to initialize your store.

import { createStore, createSwear } from "@swear-js/core";

const store = createStore();

// Create swear
const countSwear = createSwear('count', 0, (mutate) => ({
   increase: () => mutate(prev => prev + 1),
   decrease: () => mutate(prev => prev - 1),
}));

// Callback is triggered on every swear update
store.subscribe(countSwear, (newValue) => {
    // Handle updates of countSwear
    console.log(newValue);
});

// This will return object of actions with default actions: set() and reset(), and your own defined actions.
const actions = store.getSwearActions(countSwear);
const { set, reset, increase, decrease } = actions; // set() and reset() are default actions

increase(); // When you dispatch an action, swear value is mutated, and subscribtion callback is triggered.

Default actions

store.getSwearActions() returns an object of combined default actions and your actions.

set() action implements the same usage interface as React's useState setter. It means you can pass both a payload, and callback with previous value. Example: set((prev) => prev + 10);

Logging

You can pass your custom logger to the store, or use @swear-js/logger. Swear-js logger usage:

import { createStore } from "@swear-js/core";
import { swearLogger } from "@swear-js/logger";

const store = createStore({ onPatch: swearLogger });

In order to implement your own logger solution, you just have to keep in mind an API of onPatch argument of the store. onPatch is any callback that get SwearPatch(you can find it in package) type as an argument. Simply SwearPatch is:

{
  swearId, // String value which gets a name of patched swear state
  tag, // String value which gets an optional tag, you want to set
  prev, // Previous store state (object)
  payload, // Payload passed
  next // Current store state
}

Example very-simple implementation of logger:

import { SwearPatch, createStore } from "@swear-js/core";

const logger = ({ swearId, tag, prev, payload, next }: SwearPatch) => {
    console.log(`Swear: ${swearId}, Tag: ${tag}, Payload: ${payload}`);
    console.log(`Previous state: ${prev}`, `Current state: ${next}`);
};

const store = createStore({ onPatch: logger });

Inspired by @artalar's Reatom.