MapStack

An object that has characteristics of both map and stack.

Installation

npm i mapstack

Usage

import { MapStack } from 'mapstack';

let mapStack = new MapStack();

mapStack.push('key','value');
mapStack.push('key_2','value_2');
mapStack.push('key_3','value_3');

console.log(mapStack.get('key')); // => 'value'
console.log(mapStack.length); // => 2

// if push value with the old key, 
// the item will be taken to last position of the stack. 
mapStack.push('key','newValue');
console.log(mapStack.last); // => 'newValue'

// iterate the stack
for (let item of mapStack) {
    console.log(item); // => { key: ..., value: ... }
}

API

For more detailed usage, see the test file.

interface StackItem {
    key: string;
    value: any;
}

interface MapStack<T = any> implements Iterable<StackItem<string, T>> {
    items: StackItem[];
    constructor(items?: Record<string, any>);
    push(key: string, value: T): void;
    pop(): void;
    delete(key: string): boolean;
    clear(): void;
    indexOf(key: string): number;
    get(key: string): T | undefined;
    has(key: string): boolean;
    set(key: string, value: T): void;
    first: T | undefined;
    last: T | undefined;
    isEmpty: boolean;
    length: number;
    [Symbol.iterator](): {
        next(): IteratorResult<StackItem<string, T>>;
    };
}