@grainlogic/stack

Stack

An array based stack implementation. Allocation of memory for the stack is lazy during the first call to modifying methods. If necessary, you can replace the internal implementation with a more suitable one for your tasks.

Support for...of and Array.from()

API

Class Stack<T>

Type parameters:

• T - stack element type

Constructor(deep: number): Stack<T>

Creates a stack instance at the specified depth. The default implementation creates an array of length deep.

Exceptions:

• ArgumentNullError - an exception thrown if you do not pass the deep parameter;
• StackDepthNegativeError - an exception thrown if value of the deep parameter is less than zero.

Note. If you pass deep +Infinity as the parameter value, then an array will be created with no explicit length limit.

Methods

push (item: T): void

Add item to the top of the stack.

Exceptions:

• StackOverflowError - an exception thrown when trying to add an item to the full stack.

pop (): T

Remove item from the top of the stack and return it.

Exceptions:

• StackUnderflowError - an exception thrown when an attempt to pop an element from empty stack.

clear (): void

Clear all elements from the stack.

Exceptions:

• StackUnderflowError - an exception thrown when trying to clear an empty stack.

Properties

readonly size: number

Current number of items on the stack.

readonly isFull: boolean

Stack full indicator.

readonly isEmpty: boolean

Stack empty indicator.

view: StackView<T>

Internal stack representation.

This property is initialized lazily the first time it is accessed. After initialization, you cannot change the property value. Implements the Method Injection pattern with the default Array dependency.

If necessary, you can replace the default implementation with your own, for example a linked list or a typed array.

Exceptions:

• ArgumentNullError - an exception thrown when trying to set the property to null or undefined;
• PropertyAlreadyDefineError - an exception thrown when trying to reinitialize a property.