Class CellStream<TItem, TKey>`Abstract`

Common base class for collections of cells that can be mapped and filtered.

Type Parameters

TItem
TKey

Hierarchy (View Summary)

CellStream
- CellArray
- CellMap

Implements

CellIterable<Cell<TItem>, TKey>

Index

Constructors

Accessors

Methods

filter map mapKey observe

Constructors

constructor

new CellStream<TItem, TKey>(): CellStream<TItem, TKey>
Type Parameters
- TItem
- TKey
Returns CellStream<TItem, TKey>

Accessors

indexed

get indexed(): CellStream<TItem, Cell<number>>
Create a stream that assigns an index, starting at 0, to eachitem in this stream. The indices are cells that will update when items are removed.

Returns CellStream<TItem, Cell<number>>
A new stream.
- Defined in src/array.tsx:172

Methods

filter

filter(f: (item: TItem) => boolean): CellStream<TItem, TKey>
Create a stream that only includes items from this stream for which the given predicate function returns true.
Parameters
- f: (item: TItem) => boolean
  The predicate function to apply to items.
Returns CellStream<TItem, TKey>
A new stream.
- Defined in src/array.tsx:96

map

map<TOut>(f: (item: TItem, key: TKey) => TOut): CellStream<TOut, TKey>
Create a strem that applies a function to each item emitted by this stream.
Type Parameters
- TOut
Parameters
- f: (item: TItem, key: TKey) => TOut
  The function to apply to items.
Returns CellStream<TOut, TKey>
A new stream.
- Defined in src/array.tsx:69

mapKey

mapKey<TOut>(f: (item: Cell<TItem>, key: TKey) => TOut): CellStream<TItem, TOut>
Create a strem that applies a function to the key of each item emitted by this stream.
Type Parameters
- TOut
Parameters
- f: (item: Cell<TItem>, key: TKey) => TOut
  The function to apply to items. The returned value will be the new key.
Returns CellStream<TItem, TOut>
A new stream.
- Defined in src/array.tsx:83

`Abstract`observe

observe(
insert: (index: number, item: Cell<TItem>, key: TKey) => void,
remove: (index: number) => void,
): () => void
Observe this iterable. Upon attaching an observer insert is called for each item currently contained in the underlying collection.
Parameters
- insert: (index: number, item: Cell<TItem>, key: TKey) => void
  An observer that is called whenever an item is inserted.
- remove: (index: number) => void
  An observer that is called whenever an item is removed.
Returns () => void
A function that should be called to detach the observer functions.
Implementation of CellIterable.observe
- Defined in src/array.tsx:57