# state-history

> A state history manager

Latest version **1.2.1** (published 2020-01-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install state-history
pnpm add state-history
yarn add state-history
bun add state-history
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2020-01-15 |
| First published | 2019-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | doguh |
| Maintainers | doguh |

## Links

- npm: https://www.npmjs.com/package/state-history
- Repository: https://github.com/doguh/state-history
- Homepage: https://github.com/doguh/state-history#readme
- Issues: https://github.com/doguh/state-history/issues
- npm.io page: https://npm.io/package/state-history

## Recent versions

- 1.2.1 (latest) — 2020-01-15
- 1.2.0 — 2020-01-15
- 1.1.5 — 2019-07-29
- 1.1.4 — 2019-07-25
- 1.1.3 — 2019-07-25
- 1.1.2 — 2019-07-25
- 1.1.1 — 2019-07-25
- 1.1.0 — 2019-07-25
- 1.0.0 — 2019-07-24

## README

# state-history

[![NPM](https://img.shields.io/npm/v/state-history.svg)](https://www.npmjs.com/package/state-history)

A basic state history manager.

## Install

`npm i state-history`

## Basic usage

```js
import { StateHistory } from 'state-history';
// or
const { StateHistory } = require('state-history');

// create history
const history = new StateHistory();

// push some states
history.push({ a: 1 });
history.push({ a: 2 });
history.push({ a: 3 }); // current history is { a: 3 }

history.goPrev(); // current history is now { a: 2 }
history.goNext(); // current history is now { a: 3 }
history.go(-2); // current history is now { a: 1 }

// listen to history changes
history.subscribe(newState => console.log(newState));
history.push({ a: 1 }); // triggers an history change
history.goPrev(); // also triggers an history change
```

## Properties

```ts
// number of past states in the history
// it should be checked to be greater than 0 before calling `goPrev`
numPrev: number;

// number of future states in the history
// it should be checked to be greater than 0 before calling `goNext`
numNext: number;
```

## Methods

```ts
// push a new entry onto the history stack
// and returns it
push(state: T): T;

// moves the pointer in the history stack to the previous entry
// and returns the new current state
// it is equivalent to `go(-1)`
goPrev(): T;

// moves the pointer in the history stack to the next entry
// and returns the new current state
// it is equivalent to `go(1)`
goNext(): T;

// moves the pointer in the history stack to the last entry
// and returns the new current state
// it is  equivalent to `go(numNext)`
goLast(): T;

// moves the pointer in the history stack by `i` entries
// a negative number will go to the `-i`th previous entry
// and a positive number will go to the `i`th next entry
go(i: number): T;

// get a specific entry from the history stack
// ie: `-1` for the previous entry, `1` for the next entry
get(i: number): T;

// register a callback function that will be called every time
// a new entry is added or when the pointer in the history stack is moved
subscribe(callback: (state: T) => void): void;

// unregister a callback function
unsubscribe(callback: (state: T) => void): void;

// unregister all callback functions
unsubscribeAll(): void;

// remove all entries from the state history
clear(): void
```

---
_Source: https://npm.io/package/state-history · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
