slim-stack/dist/index.d.ts

stack implementation for JavaScript

/*!
 * slim-stack <https://github.com/nivrith/slim-stack>
 *
 * Copyright (c) Nivrith
 * Licensed under the MIT License.
 */
/**
 *
 *
 * @export
 * @class SlimStack
 * @template T
 */
export declare class SlimStack<T> {
    /**
     *
     *
     * @private
     * @type {Array<T>}
     * @memberof SlimStack
     */
    private stack;
    /**
     *
     *
     * @private
     * @type {number}
     * @memberof SlimStack
     */
    private length;
    /**
     *Creates an instance of SlimStack.
     * @param {Array<T>} [array=[]]
     * @memberof SlimStack
     */
    constructor(array?: Array<T>);
    /**
     *
     *
     * @memberof SlimStack
     */
    push(item: T): number;
    /**
     *
     *
     * @memberof SlimStack
     */
    pop(): T | undefined;
    /**
     *
     *
     * @memberof SlimStack
     */
    size(): number;
    /**
     *
     *
     * @memberof SlimStack
     */
    peek(): T;
    /**
     *
     *
     * @memberof SlimStack
     */
    [Symbol.iterator](): IterableIterator<T>;
}