Class KavenStack<T>

Represents a variable size last-in-first-out (LIFO) collection of instances of the same specified type.

Since

1.1.19

Version

2021-12-14

Type Parameters

  • T

Hierarchy

  • KavenStack

Implements

Constructors

constructor

Properties

array maxSize

Accessors

Count MaxSize

Methods

Clear Contains Peek Pop Push ToArray

Constructors

constructor

  • Type Parameters

    • T

    Returns KavenStack<T>

  • Type Parameters

    • T

    Parameters

    • maxSize: number

    Returns KavenStack<T>

Properties

Protected array

array: T[]

Protected Optional maxSize

maxSize?: number

Accessors

Count

  • get Count(): number

  • Gets the number of elements contained in the KavenStack.

    Returns

    The number of elements contained in the KavenStack.

    Returns number

MaxSize

  • get MaxSize(): undefined | number

  • Returns undefined | number

Methods

Clear

  • Clear(): void

  • Removes all objects from the KavenStack.

    Returns void

Contains

  • Contains(item: T): boolean

  • Determines whether an element is in the KavenStack.

    Parameters

    • item: T

      The object to locate in the KavenStack. The value can be undefined.

    Returns boolean

Peek

  • Peek(): undefined | T

  • Returns the object at the top of the KavenStack without removing it.

    Returns

    The object at the top of the KavenStack.

    Returns undefined | T

Pop

  • Pop(): undefined | T

  • Removes and returns the object at the top of the KavenStack.

    Returns

    The object removed from the top of the KavenStack.

    Returns undefined | T

Push

  • Push(item: T): void

  • Inserts an object at the top of the KavenStack.

    Parameters

    • item: T

      The object to push onto the KavenStack. The value can be undefined.

    Returns void

ToArray

  • ToArray(): T[]

  • Copies the KavenStack to a new array.

    Returns

    A new array containing copies of the elements of the KavenStack.

    Returns T[]

Settings

Member Visibility

Theme

Generated using TypeDoc