Class ObservableStack<T>

An observable FILO stack

Type Parameters

Implements

Disposable

Index

Constructors

constructor

new ObservableStack<T>(): ObservableStack<T>
Type Parameters
- T
Returns ObservableStack<T>
- Defined in src/helpers/observable-stack.ts:35

Properties

`Readonly`bottom$

bottom$: Observable<undefined | T>

Observable returning the element at the bottom of the stack

`Readonly`bottomDelta$

bottomDelta$: Observable<ObservableStackDelta<T>>

Observable returning the current bottom element and whether it was just added

`Readonly`empty$

empty$: Observable<boolean>

An observable emitting true if there are no items in the stack

`Readonly`itemAdded$

itemAdded$: Observable<ObservableStackItem<T>>

Emits for every item that is added to the stack

`Readonly`itemDelta$

itemDelta$: Observable<ObservableStackItemChange<T>>

Emits for every item that is added/removed in the stack, including the changes from an empty stack to the current state

`Readonly`itemRemoved$

itemRemoved$: Observable<ObservableStackItem<T>>

Emits for every item that is removed from the stack

`Readonly`items$

items$: Observable<T[]> = ...

An observable containing the items of the stack from bottom to top

`Readonly`itemUpdates$

itemUpdates$: Observable<ObservableStackItemChange<T>>

Emits for every item that is added or removed from the stack

`Readonly`length$

length$: Observable<number>

An observable emitting the number of items in the stack

`Readonly`top$

top$: Observable<undefined | T>

Observable returning the element at the top of the stack

`Readonly`topDelta$

topDelta$: Observable<ObservableStackDelta<T>>

Observable returning the current top element and whether it was just added

`Readonly`updates$

updates$: Observable<T[]>

Emits all updates to the stack

Accessors

bottom

get bottom(): undefined | T
Element at the bottom of the stack

Returns undefined | T
- Defined in src/helpers/observable-stack.ts:133

empty

get empty(): boolean
True if there are no items in the stack

Returns boolean
- Defined in src/helpers/observable-stack.ts:31

items

get items(): T[]
A list of items in the stack from bottom to top

Returns T[]
- Defined in src/helpers/observable-stack.ts:17
set items(items): void
Parameters
- items: T[]
Returns void
- Defined in src/helpers/observable-stack.ts:21

length

get length(): number
The number of items in the stack

Returns number
- Defined in src/helpers/observable-stack.ts:26

top

get top(): undefined | T
Element at the top of the stack

Returns undefined | T
- Defined in src/helpers/observable-stack.ts:122

Methods

addToBottom

addToBottom(item): void
Add item to the bottom of the stack
Parameters
- item: T
  Item to add
Returns void
- Defined in src/helpers/observable-stack.ts:293
addToBottom(...items): void
Add items to the bottom of the stack
Parameters
- Rest...items: T[]
  Items to add
Returns void
- Defined in src/helpers/observable-stack.ts:298

clear

clear(): void
Remove all elements from the set

Returns void
- Defined in src/helpers/observable-stack.ts:314

contains

contains(item): boolean
Checks if the item exists in the queue
Parameters
- item: T
Returns boolean
- Defined in src/helpers/observable-stack.ts:307

dispose

dispose(): void
Dispose of the Scheduler. This closes all subjects.

Returns void
Implementation of Disposable.dispose
- Defined in src/helpers/observable-stack.ts:324

pop

pop(): undefined | T
Remove the top element from the stack and return it

Returns undefined | T
- Defined in src/helpers/observable-stack.ts:252
pop(count): T[]
Remove the top x elements from the stack and return it
Parameters
- count: number
  The amount of elements to remove
Returns T[]
- Defined in src/helpers/observable-stack.ts:257

push

push(item): void
Add item to the top of the stack
Parameters
- item: T
  Item to add
Returns void
- Defined in src/helpers/observable-stack.ts:279
push(...items): void
Add items to the top of the stack
Parameters
- Rest...items: T[]
  Items to add
Returns void
- Defined in src/helpers/observable-stack.ts:284

removeFromBottom

removeFromBottom(): undefined | T
Remove the bottom element from the stack and return it

Returns undefined | T
- Defined in src/helpers/observable-stack.ts:227
removeFromBottom(count): T[]
Remove the bottom x elements from the stack and return them
Parameters
- count: number
  The amount of elements to remove
Returns T[]
- Defined in src/helpers/observable-stack.ts:232

removeItem

removeItem(item): boolean
Removes an item from the scheduler
Parameters
- item: T
Returns boolean
- Defined in src/helpers/observable-stack.ts:214

Class ObservableStack<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns ObservableStack<T>

Properties

Readonlybottom$

ReadonlybottomDelta$

Readonlyempty$

ReadonlyitemAdded$

ReadonlyitemDelta$

ReadonlyitemRemoved$

Readonlyitems$

ReadonlyitemUpdates$

Readonlylength$

Readonlytop$

ReadonlytopDelta$

Readonlyupdates$

Accessors

bottom

Returns undefined | T

empty

Returns boolean

items

Returns T[]

Parameters

Returns void

length

Returns number

top

Returns undefined | T

Methods

addToBottom

Parameters

Returns void

Parameters

Returns void

clear

Returns void

contains

Parameters

Returns boolean

dispose

Returns void

pop

Returns undefined | T

Parameters

Returns T[]

push

Parameters

Returns void

Parameters

Returns void

removeFromBottom

Returns undefined | T

Parameters

Returns T[]

removeItem

Parameters

Returns boolean

Settings

On This Page

`Readonly`bottom$

`Readonly`bottomDelta$

`Readonly`empty$

`Readonly`itemAdded$

`Readonly`itemDelta$

`Readonly`itemRemoved$

`Readonly`items$

`Readonly`itemUpdates$

`Readonly`length$

`Readonly`top$

`Readonly`topDelta$

`Readonly`updates$