Class BaseTripleStore<Id, V>`Abstract`

TripleStore base class.

Type Parameters

Id
V

Hierarchy

BaseTripleStore
- MapTripleStore

Implements

TripleStore<Id, V>
AsyncIterable<[EntityAttrKey<Id>, V]>

Index

Constructors

Accessors

[rangeQueryable] [toStringTag]

Methods

[asyncIterator] delete deleteMany entries entriesByAttr findMany findManyByAttr get getMany has hasMany keys keysByAttr set setMany updateMany values valuesByAttr

Constructors

constructor

new BaseTripleStore<Id, V>(): BaseTripleStore<Id, V>
Type Parameters
- Id
- V
Returns BaseTripleStore<Id, V>

Accessors

[rangeQueryable]

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

Returns true
Implementation of TripleStore.[rangeQueryable]
- Defined in collections/src/triplestore/base.ts:88

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in collections/src/triplestore/base.ts:92

Methods

[asyncIterator]

[asyncIterator](): AsyncIterator<[EntityAttrKey<Id>, V], any, undefined>
Returns AsyncIterator<[EntityAttrKey<Id>, V], any, undefined>
Implementation of AsyncIterable.[asyncIterator]
- Defined in collections/src/triplestore/base.ts:84

delete

delete(key, options?): Promise<void>
Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: EntityAttrKey<Id>
- Optional options: AbortOptions
Returns Promise<void>
Implementation of TripleStore.delete
- Defined in collections/src/triplestore/base.ts:56

deleteMany

deleteMany(keys, options?): MaybeAsyncIterableIterator<undefined | Error>
Deletes the values with given keys.
Parameters
- keys: Iterable<EntityAttrKey<Id>>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | Error>
Implementation of TripleStore.deleteMany
- Defined in collections/src/triplestore/base.ts:78

`Abstract` 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]>
Implementation of TripleStore.entries
- Defined in collections/src/triplestore/base.ts:7

`Abstract` entriesByAttr

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

`Abstract` 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]>>
Implementation of TripleStore.findMany
- Defined in collections/src/triplestore/base.ts:15

`Abstract` 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]>>
Implementation of TripleStore.findManyByAttr
- Defined in collections/src/triplestore/base.ts:19

get

get(key, options?): Promise<undefined | V>
Gets a value by key from the map.
Parameters
- key: EntityAttrKey<Id>
- Optional options: AbortOptions
Returns Promise<undefined | V>
Implementation of TripleStore.get
- Defined in collections/src/triplestore/base.ts:47

`Abstract` 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>
Implementation of TripleStore.getMany
- Defined in collections/src/triplestore/base.ts:23

has

has(key, options?): Promise<boolean>
Returns whether a key exists in the map.
Parameters
- key: EntityAttrKey<Id>
- Optional options: AbortOptions
Returns Promise<boolean>
Implementation of TripleStore.has
- Defined in collections/src/triplestore/base.ts:51

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<EntityAttrKey<Id>>
- Optional options: AbortOptions
Returns AsyncIterableIterator<boolean>
Implementation of TripleStore.hasMany
- Defined in collections/src/triplestore/base.ts:68

keys

keys(options?): AsyncIterableIterator<EntityAttrKey<Id>>
Queries keys by given criteria.
Parameters
- Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>
Returns AsyncIterableIterator<EntityAttrKey<Id>>
Implementation of TripleStore.keys
- Defined in collections/src/triplestore/base.ts:31

keysByAttr

keysByAttr(options?): AsyncIterableIterator<EntityAttrKey<Id>>
Iterates keys by given attribute key range.
Parameters
- Optional options: RangeQueryOptions<AttrSearchKey>
Returns AsyncIterableIterator<EntityAttrKey<Id>>
Implementation of TripleStore.keysByAttr
- Defined in collections/src/triplestore/base.ts:39

set

set(key, value, options?): Promise<void>
Sets an entry in the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: EntityAttrKey<Id>
- value: V
- Optional options: AbortOptions
Returns Promise<void>
Implementation of TripleStore.set
- Defined in collections/src/triplestore/base.ts:62

setMany

setMany(entries, options?): MaybeAsyncIterableIterator<undefined | Error>
Sets given list of entries.
Parameters
- entries: Iterable<readonly [EntityAttrKey<Id>, V]>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | Error>
Implementation of TripleStore.setMany
- Defined in collections/src/triplestore/base.ts:72

`Abstract` updateMany

updateMany(entries, options?): MaybeAsyncIterableIterator<undefined | Error>
Sets or deletes given list of entries.
Parameters
- entries: Iterable<readonly [EntityAttrKey<Id>, undefined | V]>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | Error>
Implementation of TripleStore.updateMany
- Defined in collections/src/triplestore/base.ts:27

values

values(options?): AsyncIterableIterator<V>
Queries values by given criteria.
Parameters
- Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>
Returns AsyncIterableIterator<V>
Implementation of TripleStore.values
- Defined in collections/src/triplestore/base.ts:35

valuesByAttr

valuesByAttr(options?): AsyncIterableIterator<V>
Iterates values by given attribute key range.
Parameters
- Optional options: RangeQueryOptions<AttrSearchKey>
Returns AsyncIterableIterator<V>
Implementation of TripleStore.valuesByAttr
- Defined in collections/src/triplestore/base.ts:43

Generated using TypeDoc