Interface ReadonlyTripleStore<Id, V>

Readonly TripleStore.

interface ReadonlyTripleStore {
    [rangeQueryable]: true;
    entries(options?): MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>;
    entriesByAttr(options?): MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>;
    findMany(keys, options?): MaybeAsyncIterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>;
    findManyByAttr(keys, options?): MaybeAsyncIterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>;
    get(key, options?): MaybePromise<undefined | V>;
    getMany(keys, options?): MaybeAsyncIterableIterator<undefined | V>;
    has(key, options?): MaybePromise<boolean>;
    hasMany(keys, options?): MaybeAsyncIterableIterator<boolean>;
    keys(options?): MaybeAsyncIterableIterator<EntityAttrKey<Id>>;
    keysByAttr(options?): MaybeAsyncIterableIterator<EntityAttrKey<Id>>;
    values(options?): MaybeAsyncIterableIterator<V>;
    valuesByAttr(options?): MaybeAsyncIterableIterator<V>;
}

Type Parameters

Id
V

Hierarchy

MaybeAsyncReadonlyMap<EntityAttrKey<Id>, V>
MaybeAsyncReadonlyMapBatch<EntityAttrKey<Id>, V>
RangeQueryable<EntityAttrSearchKey<Id>, V>
- ReadonlyTripleStore
  - TripleStore

Index

Properties

[rangeQueryable]

Methods

entries entriesByAttr findMany findManyByAttr 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(options?): MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>
Queries key-value pairs by given criteria.
Parameters
- Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>
Returns MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>
Overrides RangeQueryable.entries
- Defined in collections/src/triplestore.ts:18

entriesByAttr

entriesByAttr(options?): MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>
Iterates entries by given attribute key range.
Parameters
- Optional options: RangeQueryOptions<AttrSearchKey>
Returns MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>
- Defined in collections/src/triplestore.ts:27

findMany

findMany(keys, options?): MaybeAsyncIterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>
Finds matching entries for given list of entity-attribute search keys.
Parameters
- keys: Iterable<EntityAttrSearchKey<Id>>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>
- Defined in collections/src/triplestore.ts:30

findManyByAttr

findManyByAttr(keys, options?): MaybeAsyncIterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>
Finds matching entries for given list of attribute-value search keys.
Parameters
- keys: Iterable<AttrSearchKey>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>
- Defined in collections/src/triplestore.ts:35

get

get(key, options?): MaybePromise<undefined | V>
Gets a value by key from the map.
Parameters
- key: EntityAttrKey<Id>
- Optional options: AbortOptions
Returns MaybePromise<undefined | V>
Inherited from MaybeAsyncReadonlyMap.get
- Defined in collections/src/map.ts:7

getMany

getMany(keys, options?): MaybeAsyncIterableIterator<undefined | V>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<EntityAttrKey<Id>>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | V>
Inherited from MaybeAsyncReadonlyMapBatch.getMany
- Defined in collections/src/map.ts:47

has

has(key, options?): MaybePromise<boolean>
Returns whether a key exists in the map.
Parameters
- key: EntityAttrKey<Id>
- Optional options: AbortOptions
Returns MaybePromise<boolean>
Inherited from MaybeAsyncReadonlyMap.has
- Defined in collections/src/map.ts:10

hasMany

hasMany(keys, options?): MaybeAsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<EntityAttrKey<Id>>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<boolean>
Inherited from MaybeAsyncReadonlyMapBatch.hasMany
- Defined in collections/src/set.ts:24

keys

keys(options?): MaybeAsyncIterableIterator<EntityAttrKey<Id>>
Queries keys by given criteria.
Parameters
- Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>
Returns MaybeAsyncIterableIterator<EntityAttrKey<Id>>
Overrides RangeQueryable.keys
- Defined in collections/src/triplestore.ts:14

keysByAttr

keysByAttr(options?): MaybeAsyncIterableIterator<EntityAttrKey<Id>>
Iterates keys by given attribute key range.
Parameters
- Optional options: RangeQueryOptions<AttrSearchKey>
Returns MaybeAsyncIterableIterator<EntityAttrKey<Id>>
- Defined in collections/src/triplestore.ts:21

values

values(options?): MaybeAsyncIterableIterator<V>
Queries values by given criteria.
Parameters
- Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>
Returns MaybeAsyncIterableIterator<V>
Overrides RangeQueryable.values
- Defined in collections/src/triplestore.ts:16

valuesByAttr

valuesByAttr(options?): MaybeAsyncIterableIterator<V>
Iterates values by given attribute key range.
Parameters
- Optional options: RangeQueryOptions<AttrSearchKey>
Returns MaybeAsyncIterableIterator<V>
- Defined in collections/src/triplestore.ts:24

Generated using TypeDoc