Class ReadonlyORMap<V, Id>

constructor

• new ReadonlyORMap<V, Id>(store, entityId, stringify?): ReadonlyORMap<V, Id>

• Type Parameters

  • V = unknown

  • Id = ContentId<number, number>

  Parameters

  • store: ReadonlyTripleStore<Id, V>

    The underlying store.

  • entityId: Id

    The map entity ID.

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

    Function for converting value to hash string.

    • • (value, options?): MaybePromise<string>

      • Function for converting value to hash string.

        Parameters

        • value: V

        • Optional options: AbortOptions

        Returns MaybePromise<string>

  Returns ReadonlyORMap<V, Id>

Readonly entityId

[rangeQueryable]

• get [rangeQueryable](): true

• Marker to indicate that this object is a RangeQueryable.

  Returns true

[toStringTag]

• get [toStringTag](): string

• Returns string

[asyncIterator]

• [asyncIterator](): AsyncIterator<[string, V], any, undefined>

• Returns AsyncIterator<[string, V], any, undefined>

entries

• entries(options?): AsyncIterableIterator<[string, V]>

• Queries key-value pairs by given criteria.

  Parameters

  • Optional options: RangeQueryOptions<string>

  Returns AsyncIterableIterator<[string, V]>

get

• get(key, options?): Promise<undefined | V>

• Gets a value by key from the map.

  Parameters

  • key: string

  • Optional options: AbortOptions

  Returns Promise<undefined | V>

getList

• getList(key): ReadonlyLSeq<V, Id>

• Parameters

  • key: string

  Returns ReadonlyLSeq<V, Id>

getMany

• getMany(keys, options?): AsyncIterableIterator<undefined | V>

• Gets the list of data identified by given keys.

  Parameters

  • keys: Iterable<string>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<undefined | V>

getSet

• getSet(key): ReadonlyORSet<V, Id>

• Parameters

  • key: string

  Returns ReadonlyORSet<V, Id>

has

• has(key, options?): Promise<boolean>

• Returns whether a key exists in the map.

  Parameters

  • key: string

  • Optional options: AbortOptions

  Returns Promise<boolean>

hasMany

• hasMany(keys, options?): AsyncIterableIterator<boolean>

• Checks if given keys exist in the set.

  Parameters

  • keys: Iterable<string>

  • Optional options: AbortOptions

  Returns AsyncIterableIterator<boolean>

keys

• keys(options?): AsyncIterableIterator<string>

• Queries keys by given criteria.

  Parameters

  • Optional options: RangeQueryOptions<string>

  Returns AsyncIterableIterator<string>

values

• values(options?): AsyncIterableIterator<V>

• Queries values by given criteria.

  Parameters

  • Optional options: RangeQueryOptions<string>

  Returns AsyncIterableIterator<V>