Package Exports

history-stack
history-stack/history-stack.cjs.min.js
history-stack/history-stack.es.min.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (history-stack) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

HistoryStack

A simple history recording tool library.

Install

npm i history-stack

<script src='https://cdn.jsdelivr.net/npm/history-stack'></script>

Usage

import HistoryStack from 'history-stack';
const history = new HistoryStack();

history.push('11');
history.push('22');

const h1 = history.back();
if(!history.isEnd(h1)){
    // do something with h1
}

const h2 = history.forward();
if(!history.isEnd(h2)){
    // do something with h2
}
history.step;
history.size;
history.max;
history.index;
history.list;
history.End;

history.setMax(100);

More option

import HistoryStack from 'history-stack';
const history = new HistoryStack<string>({
    max: 1000,
    useStorage: true,
    storageKey: 'history-stack',
    mode: HistoryStack.Mode.Append,
    onStepChange(step){
        console.log(`onStepChange: step=${step}`);
    },
    onHistorySizeChange(size){
        console.log(`onHistorySizeChange: size=${size}`);
    },
    onHistoryOut(data){
        console.log(`onHistoryOut: data=`, data);
    }
});

typings

export declare enum HistoryMode {
    Fork = 0,
    Append = 1
}
export interface StorageProvider<T = any> {
    read(): T[] | Promise<T[]>;
    write(data: T[]): void | Promise<void>;
}
export declare class HistoryStack<T = any> {
    static Mode: typeof HistoryMode;
    step: number;
    size: number;
    max: number;
    list: T[];
    index: number;
    End: T;
    isActive: boolean;
    private osc?;
    private ohsc?;
    private oho?;
    mode: HistoryMode;
    storageProvider: StorageProvider<T>;
    constructor({ max, useStorage, storageKey, mode, storageProvider, onStepChange, onHistorySizeChange, onHistoryOut, }?: {
        max?: number;
        useStorage?: boolean;
        mode?: HistoryMode;
        storageKey?: string;
        storageProvider?: StorageProvider<T>;
        onStepChange?: (step: number) => void;
        onHistorySizeChange?: (size: number) => void;
        onHistoryOut?: (data: T) => void;
    });
    useCache(list: T[]): void;
    setMax(max: number): void;
    private setStep;
    private setHistoryIndex;
    back(i?: number): T;
    canBack(i?: number): boolean;
    first(): typeof End | T;
    last(): typeof End | T;
    forward(i?: number): T;
    isEnd(v: T): boolean;
    canForward(i?: number): boolean;
    pop(n?: number): T[];
    push(...data: T[]): void;
    clear(): void;
    replace(v: T, i?: number): void;
    get isLatest(): boolean;
    private _onListChange;
    current(): T;
}