Interface PeekableStack<T>

A Stack that supports peeking the back (top) element.

interface PeekableStack {
    back(options?): MaybePromise<undefined | T>;
    pop(options?): MaybePromise<undefined | T>;
    push(item, options?): unknown;
}

Type Parameters

T

Hierarchy

Stack<T>
- PeekableStack

Index

Methods

Methods

back

back(options?): MaybePromise<undefined | T>
Returns the top element of this Stack, or undefined if empty.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<undefined | T>
Overrides Stack.back
- Defined in collections/src/stack.ts:17

pop

pop(options?): MaybePromise<undefined | T>
Removes and returns the top element of this Stack, or undefined if empty.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<undefined | T>
Inherited from Stack.pop
- Defined in collections/src/stack.ts:12

push

push(item, options?): unknown
Adds an element to this Stack.
Parameters
- item: T
- Optional options: AbortOptions
Returns unknown
Inherited from Stack.push
- Defined in collections/src/stack.ts:9

Generated using TypeDoc