Interface ReadonlyEntityCollection<Id, V>

Readonly entity view collection.

interface ReadonlyEntityCollection {
    [rangeQueryable]: true;
    entries<L>(options?): MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>;
    entriesByAttr<L>(options?): MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>;
    get<L>(id, options?): MaybePromise<undefined | EntityView<V, L>>;
    getMany<L>(ids, options?): MaybeAsyncIterableIterator<undefined | EntityView<V, L>>;
    has(id, options?): MaybePromise<boolean>;
    hasMany(ids, options?): MaybeAsyncIterableIterator<boolean>;
    keys<L>(options?): MaybeAsyncIterableIterator<Id>;
    keysByAttr<L>(options?): MaybeAsyncIterableIterator<Id>;
    values<L>(options?): MaybeAsyncIterableIterator<EntityView<V, L>>;
    valuesByAttr<L>(options?): MaybeAsyncIterableIterator<EntityView<V, L>>;
}

Type Parameters

Hierarchy

MaybeAsyncReadonlyMap<Id, EntityView<V>>
MaybeAsyncReadonlyMapBatch<Id, EntityView<V>>
RangeQueryable<Id, EntityView<V>>
- ReadonlyEntityCollection

Implemented by

ReadonlyOREntityCollection

Index

Properties

[rangeQueryable]

Methods

entries entriesByAttr get getMany has hasMany keys keysByAttr values valuesByAttr

Properties

`Readonly` [rangeQueryable]

[rangeQueryable]: true

Marker to indicate that this object is a RangeQueryable.

Methods

entries

entries<L>(options?): MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>
Queries key-value pairs by given criteria.
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityRangeQueryOptions<Id, V, L>
Returns MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>
Overrides RangeQueryable.entries
- Defined in crdt/src/view/entity.ts:23

entriesByAttr

entriesByAttr<L>(options?): MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityAttrRangeQueryOptions<V, L>
Returns MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>
- Defined in crdt/src/view/entity.ts:33

get

get<L>(id, options?): MaybePromise<undefined | EntityView<V, L>>
Gets a value by key from the map.
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- id: Id
- Optional options: EntityViewOptions<V, L>
Returns MaybePromise<undefined | EntityView<V, L>>
Overrides MaybeAsyncReadonlyMap.get
- Defined in crdt/src/view/entity.ts:11

getMany

getMany<L>(ids, options?): MaybeAsyncIterableIterator<undefined | EntityView<V, L>>
Gets the list of data identified by given keys.
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- ids: Iterable<Id>
- Optional options: EntityViewOptions<V, L>
Returns MaybeAsyncIterableIterator<undefined | EntityView<V, L>>
Overrides MaybeAsyncReadonlyMapBatch.getMany
- Defined in crdt/src/view/entity.ts:15

has

has(id, options?): MaybePromise<boolean>
Returns whether a key exists in the map.
Parameters
- id: Id
- Optional options: EntityTypeOptions
Returns MaybePromise<boolean>
Overrides MaybeAsyncReadonlyMap.has
- Defined in crdt/src/view/entity.ts:19

hasMany

hasMany(ids, options?): MaybeAsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- ids: Iterable<Id>
- Optional options: EntityTypeOptions
Returns MaybeAsyncIterableIterator<boolean>
Overrides MaybeAsyncReadonlyMapBatch.hasMany
- Defined in crdt/src/view/entity.ts:21

keys

keys<L>(options?): MaybeAsyncIterableIterator<Id>
Queries keys by given criteria.
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityRangeQueryOptions<Id, V, L>
Returns MaybeAsyncIterableIterator<Id>
Overrides RangeQueryable.keys
- Defined in crdt/src/view/entity.ts:27

keysByAttr

keysByAttr<L>(options?): MaybeAsyncIterableIterator<Id>
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityAttrRangeQueryOptions<V, L>
Returns MaybeAsyncIterableIterator<Id>
- Defined in crdt/src/view/entity.ts:37

values

values<L>(options?): MaybeAsyncIterableIterator<EntityView<V, L>>
Queries values by given criteria.
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityRangeQueryOptions<Id, V, L>
Returns MaybeAsyncIterableIterator<EntityView<V, L>>
Overrides RangeQueryable.values
- Defined in crdt/src/view/entity.ts:29

valuesByAttr

valuesByAttr<L>(options?): MaybeAsyncIterableIterator<EntityView<V, L>>
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityAttrRangeQueryOptions<V, L>
Returns MaybeAsyncIterableIterator<EntityView<V, L>>
- Defined in crdt/src/view/entity.ts:41

Interface ReadonlyEntityCollection<Id, V>

Type Parameters

Id

V

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly [rangeQueryable]

Methods

entries

Type Parameters

L extends EntityAttrLookup<V>

Parameters

Optional options: EntityRangeQueryOptions<Id, V, L>

Returns MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>

entriesByAttr

Type Parameters

L extends EntityAttrLookup<V>

Parameters

Optional options: EntityAttrRangeQueryOptions<V, L>

Returns MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>

get

Type Parameters

L extends EntityAttrLookup<V>

Parameters

id: Id

Optional options: EntityViewOptions<V, L>

Returns MaybePromise<undefined | EntityView<V, L>>

getMany

Type Parameters

L extends EntityAttrLookup<V>

Parameters

ids: Iterable<Id>

Optional options: EntityViewOptions<V, L>

Returns MaybeAsyncIterableIterator<undefined | EntityView<V, L>>

has

Parameters

id: Id

Optional options: EntityTypeOptions

Returns MaybePromise<boolean>

hasMany

Parameters

ids: Iterable<Id>

Optional options: EntityTypeOptions

Returns MaybeAsyncIterableIterator<boolean>

keys

Type Parameters

L extends EntityAttrLookup<V>

Parameters

Optional options: EntityRangeQueryOptions<Id, V, L>

Returns MaybeAsyncIterableIterator<Id>

keysByAttr

Type Parameters

L extends EntityAttrLookup<V>

Parameters

Optional options: EntityAttrRangeQueryOptions<V, L>

Returns MaybeAsyncIterableIterator<Id>

values

Type Parameters

L extends EntityAttrLookup<V>

Parameters

Optional options: EntityRangeQueryOptions<Id, V, L>

Returns MaybeAsyncIterableIterator<EntityView<V, L>>

valuesByAttr

Type Parameters

L extends EntityAttrLookup<V>

Parameters

Optional options: EntityAttrRangeQueryOptions<V, L>

Returns MaybeAsyncIterableIterator<EntityView<V, L>>

Settings

Member Visibility

Theme

On This Page

`Readonly` [rangeQueryable]

`Optional` options: EntityRangeQueryOptions<Id, V, L>

`Optional` options: EntityAttrRangeQueryOptions<V, L>

`Optional` options: EntityViewOptions<V, L>

`Optional` options: EntityViewOptions<V, L>

`Optional` options: EntityTypeOptions

`Optional` options: EntityTypeOptions

`Optional` options: EntityRangeQueryOptions<Id, V, L>

`Optional` options: EntityAttrRangeQueryOptions<V, L>

`Optional` options: EntityRangeQueryOptions<Id, V, L>

`Optional` options: EntityAttrRangeQueryOptions<V, L>