Class Stack<T>

The LIFO stack implementation.

Type Parameters

T
The type of elements in the stack.

Hierarchy (View Summary)

NativeListCollection<T>
- Stack

Implements

IStack<T>

Index

Constructors

constructor

new Stack<T>(iterable?: Iterable<T, any, any>, capacity?: number): Stack<T>
Type Parameters
- T
Parameters
- Optionaliterable: Iterable<T, any, any>
- capacity: number = Infinity
Returns Stack<T>
Inherited from NativeListCollection.constructor
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:8

Properties

`Readonly`capacity

capacity: number = Infinity

The maximum number of elements the collection can hold. If the collection is unbounded, this will be Infinity.

`Protected` `Readonly`data

data: NativeArray<T>

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<T>
Returns AsyncIterator<T>
Implementation of IStack.[asyncIterator]
Inherited from NativeListCollection.[asyncIterator]
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:18

[iterator]

"[iterator]"(): Iterator<T>
Returns Iterator<T>
Implementation of IStack.[iterator]
Inherited from NativeListCollection.[iterator]
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:15

clear

clear(): void
Removes all elements from the collection.

Returns void
Implementation of IStack.clear
Inherited from NativeListCollection.clear
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:22

concat

concat(...items: T[]): IterableIterator<T>
Concatenates the given items to the end of the collection and returns an iterator over the merged items.

This method does not mutate the original collection.
Parameters
- ...items: T[]
  The items to merge.
Returns IterableIterator<T>
An iterator of the merged items.
Implementation of IStack.concat
Inherited from NativeListCollection.concat
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:30

count

count(): number
Returns the number of elements in the collection.

Returns number
Implementation of IStack.count
Inherited from NativeListCollection.count
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:26

pop

pop(): undefined | T
Removes and returns the item at the top of the stack.

Returns undefined | T
The item at the top of the stack, or undefined if the stack is empty.
Implementation of IStack.pop
- Defined in packages/misc-util/src/data/stack.ts:22

push

push(...items: T[]): void
Adds one or more items to the top of the stack.

The items are added in the order they are provided. The last item in the argument list will be the first one to be popped.
Parameters
- ...items: T[]
  The items to add to the stack.
Returns void
Throws
If the operation would exceed the stack's capacity.
Implementation of IStack.push
- Defined in packages/misc-util/src/data/stack.ts:11

remove

remove(condition: Predicate<[T]>): IterableIterator<T>
Removes all the items matching the given predicate from the collection.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the items to remove.
Returns IterableIterator<T>
An iterable of the removed items.
Implementation of IStack.remove
Inherited from NativeListCollection.remove
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:38

removeFirst

removeFirst(condition: Predicate<[T]>): boolean
Removes the first occurrence of the item matching the given predicate from the collection.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the item to remove.
Returns boolean
true if the item was found and removed, false otherwise.
Implementation of IStack.removeFirst
Inherited from NativeListCollection.removeFirst
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:34

replace

replace(
condition: Predicate<[T]>,
newItem: Callable<[T], T>,
): IterableIterator<T>
Replaces all the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the items to replace.
- newItem: Callable<[T], T>
Returns IterableIterator<T>
An iterable of the replaced items.
Implementation of IStack.replace
Inherited from NativeListCollection.replace
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:46

replaceFirst

replaceFirst(condition: Predicate<[T]>, newItem: T): boolean
Replaces the first occurence of the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the item to replace.
- newItem: T
  The new item to insert.
Returns boolean
true if the item was found and replaced, false otherwise.
Implementation of IStack.replaceFirst
Inherited from NativeListCollection.replaceFirst
- Defined in packages/misc-util/src/data/collection-base/native-array-collection.ts:42

top

top(): undefined | T
Returns the item at the top of the stack without removing it.

Returns undefined | T
The item at the top of the stack, or undefined if the stack is empty.
Implementation of IStack.top
- Defined in packages/misc-util/src/data/stack.ts:34

waitPush

waitPush(items: Iterable<T>, signal?: null | AbortSignal): Promise<void>
Same as push, but waits for capacity if the operation would exceed it.
Parameters
- items: Iterable<T>
- Optionalsignal: null | AbortSignal
  Optional abort signal to cancel the operation.
Returns Promise<void>
See
IStack.push
Implementation of IStack.waitPush
- Defined in packages/misc-util/src/data/stack.ts:15

Class Stack<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Stack<T>

Properties

Readonlycapacity

Protected Readonlydata

Methods

[asyncIterator]

Returns AsyncIterator<T>

[iterator]

Returns Iterator<T>

clear

Returns void

concat

Parameters

Returns IterableIterator<T>

count

Returns number

pop

Returns undefined | T

push

Parameters

Returns void

Throws

remove

Parameters

Returns IterableIterator<T>

removeFirst

Parameters

Returns boolean

replace

Parameters

Returns IterableIterator<T>

replaceFirst

Parameters

Returns boolean

top

Returns undefined | T

waitPush

Parameters

Returns Promise<void>

See

Settings

On This Page

`Readonly`capacity

`Protected` `Readonly`data