Class ReadonlyOREntityCollection<Id, V>

Observed-removed ReadonlyEntityCollection.

Type Parameters

Id extends ToString = ContentId
V = string | number | Id

Implements

ReadonlyEntityCollection<Id, V>
AsyncIterable<[Id, EntityView<V>]>

Index

Constructors

constructor

new ReadonlyOREntityCollection<Id, V>(state, stringify?, batchSize?): ReadonlyOREntityCollection<Id, V>
Type Parameters
- Id extends ToString = ContentId<number, number>
- V = string | number | Id
Parameters
- state: ReadonlyEntityStore<Id, V>
  The store state.
- stringify: ((value, options?) => MaybePromise<string>) = defaultStringify
  Function for converting value to string.
  - - (value, options?): MaybePromise<string>
    - Function for converting value to string.
      
      Parameters
      value: V
      Optional options: AbortOptions
      Returns MaybePromise<string>
- batchSize: number = 50
  Max size of a request batch.
Returns ReadonlyOREntityCollection<Id, V>
- Defined in crdt/src/view/orentity.ts:17

Properties

`Protected` `Readonly` batchSize

batchSize: number = 50

Max size of a request batch.

`Protected` `Readonly` state

state: ReadonlyEntityStore<Id, V>

The store state.

`Protected` `Readonly` stringify

stringify: ((value, options?) => MaybePromise<string>) = defaultStringify

Type declaration

- (value, options?): MaybePromise<string>
- Function for converting value to string.
  Parameters
  - value: V
  - Optional options: AbortOptions
  Returns MaybePromise<string>

Accessors

[rangeQueryable]

get [rangeQueryable](): true
Marker to indicate that this object is a RangeQueryable.

Returns true
Implementation of ReadonlyEntityCollection.[rangeQueryable]
- Defined in crdt/src/view/orentity.ts:137

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in crdt/src/view/orentity.ts:141

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<[Id, EntityView<V>]>
Returns AsyncIterableIterator<[Id, EntityView<V>]>
Implementation of AsyncIterable.[asyncIterator]
- Defined in crdt/src/view/orentity.ts:133

`Protected` collect

collect<L>(iter, attrs?): AsyncIterableIterator<[Id, EntityView<V, L>]>
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- iter: MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>
- Optional attrs: L
Returns AsyncIterableIterator<[Id, EntityView<V, L>]>
- Defined in crdt/src/view/orentity.ts:155

entries

entries<L>(options?): AsyncIterableIterator<[Id, EntityView<V, L>]>
Queries key-value pairs by given criteria.
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- options: EntityRangeQueryOptions<Id, V, L> = {}
Returns AsyncIterableIterator<[Id, EntityView<V, L>]>
Implementation of ReadonlyEntityCollection.entries
- Defined in crdt/src/view/orentity.ts:53

entriesByAttr

entriesByAttr<L>(options?): AsyncIterableIterator<[Id, EntityView<V, L>]>
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityAttrRangeQueryOptions<V, L>
Returns AsyncIterableIterator<[Id, EntityView<V, L>]>
Implementation of ReadonlyEntityCollection.entriesByAttr
- Defined in crdt/src/view/orentity.ts:106

get

get<L>(id, options?): Promise<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 Promise<undefined | EntityView<V, L>>
Implementation of ReadonlyEntityCollection.get
- Defined in crdt/src/view/orentity.ts:39

getEntriesMany

getEntriesMany<L>(ids, options?): MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- ids: Id[]
- Optional options: EntityViewOptions<V, L>
Returns MaybeAsyncIterableIterator<[Id, EntityView<V, L>]>
- Defined in crdt/src/view/orentity.ts:145

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>>
Implementation of ReadonlyEntityCollection.getMany
- Defined in crdt/src/view/orentity.ts:26

has

has(id, options?): Promise<boolean>
Returns whether a key exists in the map.
Parameters
- id: Id
- Optional options: EntityTypeOptions
Returns Promise<boolean>
Implementation of ReadonlyEntityCollection.has
- Defined in crdt/src/view/orentity.ts:45

hasMany

hasMany(ids, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- ids: Iterable<Id>
- Optional options: EntityTypeOptions
Returns AsyncIterableIterator<boolean>
Implementation of ReadonlyEntityCollection.hasMany
- Defined in crdt/src/view/orentity.ts:49

keys

keys<L>(options?): AsyncIterableIterator<Id>
Queries keys by given criteria.
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityRangeQueryOptions<Id, V, L>
Returns AsyncIterableIterator<Id>
Implementation of ReadonlyEntityCollection.keys
- Defined in crdt/src/view/orentity.ts:69

keysByAttr

keysByAttr<L>(options?): AsyncIterableIterator<Id>
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- options: EntityAttrRangeQueryOptions<V, L> = {}
Returns AsyncIterableIterator<Id>
Implementation of ReadonlyEntityCollection.keysByAttr
- Defined in crdt/src/view/orentity.ts:81

values

values<L>(options?): AsyncIterableIterator<EntityView<V, L>>
Queries values by given criteria.
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityRangeQueryOptions<Id, V, L>
Returns AsyncIterableIterator<EntityView<V, L>>
Implementation of ReadonlyEntityCollection.values
- Defined in crdt/src/view/orentity.ts:75

valuesByAttr

valuesByAttr<L>(options?): AsyncIterableIterator<EntityView<V, L>>
Type Parameters
- L extends EntityAttrLookup<V>
Parameters
- Optional options: EntityAttrRangeQueryOptions<V, L>
Returns AsyncIterableIterator<EntityView<V, L>>
Implementation of ReadonlyEntityCollection.valuesByAttr
- Defined in crdt/src/view/orentity.ts:127

Class ReadonlyOREntityCollection<Id, V>

Type Parameters

Id extends ToString = ContentId

V = string | number | Id

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Id extends ToString = ContentId<number, number>

V = string | number | Id

Parameters

state: ReadonlyEntityStore<Id, V>

stringify: ((value, options?) => MaybePromise<string>) = defaultStringify

Parameters

value: V

Optional options: AbortOptions

Returns MaybePromise<string>

batchSize: number = 50

Returns ReadonlyOREntityCollection<Id, V>

Properties

Protected Readonly batchSize

Protected Readonly state

Protected Readonly stringify

Type declaration

Parameters

value: V

Optional options: AbortOptions

Returns MaybePromise<string>

Accessors

[rangeQueryable]

Returns true

[toStringTag]

Returns string

Methods

[asyncIterator]

Returns AsyncIterableIterator<[Id, EntityView<V>]>

Protected collect

Type Parameters

L extends EntityAttrLookup<V>

Parameters

iter: MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>

Optional attrs: L

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

entries

Type Parameters

L extends EntityAttrLookup<V>

Parameters

options: EntityRangeQueryOptions<Id, V, L> = {}

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

entriesByAttr

Type Parameters

L extends EntityAttrLookup<V>

Parameters

Optional options: EntityAttrRangeQueryOptions<V, L>

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

get

Type Parameters

L extends EntityAttrLookup<V>

Parameters

id: Id

Optional options: EntityViewOptions<V, L>

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

getEntriesMany

Type Parameters

L extends EntityAttrLookup<V>

Parameters

ids: Id[]

Optional options: EntityViewOptions<V, L>

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

getMany

Type Parameters

L extends EntityAttrLookup<V>

Parameters

ids: Iterable<Id>

Optional options: EntityViewOptions<V, L>

`Optional` options: AbortOptions

`Protected` `Readonly` batchSize

`Protected` `Readonly` state

`Protected` `Readonly` stringify

`Optional` options: AbortOptions

`Protected` collect

`Optional` attrs: L

`Optional` options: EntityAttrRangeQueryOptions<V, L>

`Optional` options: EntityViewOptions<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: EntityRangeQueryOptions<Id, V, L>

`Optional` options: EntityAttrRangeQueryOptions<V, L>