Class StackMutable<V>

isEmpty

• get isEmpty(): boolean

  Returns true if the stack is empty, false otherwise.

  Returns boolean

isFull

• get isFull(): boolean

  Returns true if the stack is full, false otherwise. Note that a stack is only full if a maxSize option was provided at construction time.

  Returns boolean

length

• get length(): number

  Returns the number of items currently on the stack.

  Returns number

peek

• get peek(): V | undefined

  Returns the top-most item on the stack, without modifying the stack. If the stack is empty, returns undefined.

  Returns V | undefined

constructor

• new StackMutable<V>(
      opts?: StackOpts,
      data?: readonly V[],
  ): Stacks.StackMutable<V>

  Create a new StackMutable.

  Type Parameters

  • V

  Parameters

  • opts: StackOpts = {}

    Options

  • data: readonly V[] = []

    Initial data to use

  Returns Stacks.StackMutable<V>

forEach

• forEach(fn: (v: V) => void): void

  Iterate from bottom to top. Note that forEachFromTop iterates from top to bottom, so this is the reverse.

  Parameters

  • fn: (v: V) => void

  Returns void

forEachFromTop

• forEachFromTop(fn: (v: V) => void): void

  Iterate from top to bottom. Note that forEach iterates from bottom to top, so this is the reverse.

  Parameters

  • fn: (v: V) => void

  Returns void

pop

• pop(): V | undefined

  Pop the top-most item from the stack, and return it. If the stack is empty, returns undefined.

  Returns V | undefined

push

• push(...toAdd: readonly V[]): number

  Push data onto the stack. If toAdd is empty, nothing happens

  Parameters

  • ...toAdd: readonly V[]

    Data to add

  Returns number

  Length of stack

data

Readonlyopts