Class CellMap<TKey, TValue>

Type Parameters

TKey
TValue

Hierarchy (View Summary)

CellStream<TValue, TKey>
- CellMap

Index

Constructors

constructor

new CellMap<TKey, TValue>(
initialEntries?: Iterable<[TKey, TValue]>,
): CellMap<TKey, TValue>
Type Parameters
- TKey
- TValue
Parameters
- initialEntries: Iterable<[TKey, TValue]> = []
Returns CellMap<TKey, TValue>
Overrides CellStream.constructor
- Defined in src/array.tsx:409

Properties

`Readonly`onDelete

onDelete: Emitter<TKey> = ...

`Readonly`onInsert

onInsert: Emitter<{ key: TKey; value: Cell<TValue> }> = ...

`Readonly`size

size: Cell<number>

Accessors

entries

get entries(): Iterable<[TKey, MutCell<TValue>]>
Returns Iterable<[TKey, MutCell<TValue>]>
- Defined in src/array.tsx:425

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.
Inherited from CellStream.indexed
- Defined in src/array.tsx:172

keys

get keys(): Iterable<TKey>
Returns Iterable<TKey>
- Defined in src/array.tsx:417

values

get values(): Iterable<MutCell<TValue>>
Returns Iterable<MutCell<TValue>>
- Defined in src/array.tsx:421

Methods

clear

clear(): void
Returns void
- Defined in src/array.tsx:484

delete

delete(key: TKey): boolean
Parameters
- key: TKey
Returns boolean
- Defined in src/array.tsx:476

filter

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

get

get(key: TKey): undefined | TValue
Parameters
- key: TKey
Returns undefined | TValue
- Defined in src/array.tsx:457

map

map<TOut>(f: (item: TValue, 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: TValue, key: TKey) => TOut
  The function to apply to items.
Returns CellStream<TOut, TKey>
A new stream.
Inherited from CellStream.map
- Defined in src/array.tsx:69

mapKey

mapKey<TOut>(
f: (item: Cell<TValue>, key: TKey) => TOut,
): CellStream<TValue, 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<TValue>, key: TKey) => TOut
  The function to apply to items. The returned value will be the new key.
Returns CellStream<TValue, TOut>
A new stream.
Inherited from CellStream.mapKey
- Defined in src/array.tsx:83

observe

observe(
insert: (index: number, item: Cell<TValue>, 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<TValue>, 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.
Overrides CellStream.observe
- Defined in src/array.tsx:429

set

set(key: TKey, value: TValue): void
Parameters
- key: TKey
- value: TValue
Returns void
- Defined in src/array.tsx:465

update

update<T>(key: TKey, mutator: (value: TValue) => T): undefined | T
Type Parameters
- T
Parameters
- key: TKey
- mutator: (value: TValue) => T
Returns undefined | T
- Defined in src/array.tsx:461

Class CellMap<TKey, TValue>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CellMap<TKey, TValue>

Properties

ReadonlyonDelete

ReadonlyonInsert

Readonlysize

Accessors

entries

Returns Iterable<[TKey, MutCell<TValue>]>

indexed

Returns CellStream<TItem, Cell<number>>

keys

Returns Iterable<TKey>

values

Returns Iterable<MutCell<TValue>>

Methods

clear

Returns void

delete

Parameters

Returns boolean

filter

Parameters

Returns CellStream<TValue, TKey>

get

Parameters

Returns undefined | TValue

map

Type Parameters

Parameters

Returns CellStream<TOut, TKey>

mapKey

Type Parameters

Parameters

Returns CellStream<TValue, TOut>

observe

Parameters

Returns () => void

set

Parameters

Returns void

update

Type Parameters

Parameters

Returns undefined | T

Settings

On This Page

`Readonly`onDelete

`Readonly`onInsert

`Readonly`size