Giter Club home page Giter Club logo

simple-state-shot's Introduction

simple-state-shot

Build Status Coverage Status semantic-release

a simple state history manager

Getting Started

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

npm i simple-state-shot

Basic Usage

import SimpleStateShot from 'simple-state-shot';

const simpleStateShot = new SimpleStateShot();

const firstState = {foo: 1};

simpleStateShot.push(firstState);
simpleStateShot.get();  // {foo: 1}
simpleStateShot.undo().get();   // null
simpleStateShot.redo().get();   // {foo: 1}

API

options

  • maxLength - How many state the manager will store. strongly recommend to set this param to prevent memory leak
const simpleStateShot = new SimpleStateShot(10)

push

push a new state to the stack note: state should be JSON-safe.

get

get the last state. if no state in the stack, null will be returned

undo

undo the last state. if no state in the stack, null will be returned

redo

redo the last undo state.

length

the states length of current instance

reset

reset stack

hasUndo、hasRedo

whether current state has a before/after state

License

This project is licensed under the MIT License.

Inspired by StateShot

simple-state-shot's People

Contributors

namelessman avatar semantic-release-bot avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.