gis-tools-ts/dist/dataStore/multimap/mmap.js

A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.

import { S2MMapStore } from '../mmap.js';
import { compareIDs } from '../../index.js';
/**
 * # MultiMap MMap Store
 *
 * ## Description
 * A mmap multimap store
 *
 * ## Usage
 * ```ts
 * import { MMapMultiMap } from 'gis-tools-ts/mmap';
 *
 * interface Data { name: string };
 *
 * const mm = new FileMultiMap<Data>();
 * // set a key
 * mm.set(1n, { name: 'test' });
 * mm.set(1n, { name: 'test2' });
 * // get a key
 * const { name } = mm.get(1n); // [{ name: 'test' }, { name: 'test2' }]
 * // check if a key exists
 * mm.has(1n); // true
 * // get length of the store
 * console.log(mm.length); // 2
 *
 * // iterate over the store
 * for await (const entry of mm) console.log(entry);
 *
 * // close the store
 * mm.close();
 * ```
 */
export class MMapMultiMap {
    #store;
    /**
     * Builds a new MultiMap file store
     * @param fileName - the path + file name without the extension
     */
    constructor(fileName) {
        this.#store = new S2MMapStore(fileName);
    }
    /** @returns - the length of the map */
    get length() {
        return this.#store.length;
    }
    /**
     * Adds a value to the list of values associated with a key
     * @param key - the key
     * @param value - the value to store
     */
    set(key, value) {
        this.#store.set(BigInt(key), value);
    }
    /**
     * Check if the key exists
     * @param key - the key
     * @returns true if the key exists
     */
    async has(key) {
        return await this.#store.has(BigInt(key));
    }
    /**
     * Gets the list of values associated with a key
     * @param key - the key
     * @returns the list of values if the map contains values for the key
     */
    async get(key) {
        return await this.#store.get(BigInt(key));
    }
    /**
     * iterate through the values
     * @yields {MMEntry<V>} - the Key-Value iterator
     */
    async *entries() {
        let entries = [];
        for await (const entry of this.#store.entries()) {
            if (entries.length > 0) {
                const last = entries.at(-1);
                if (compareIDs(last.key, entry.key) === 0) {
                    entries.push(entry);
                }
                else {
                    yield { key: last.key, value: entries.map((e) => e.value) };
                    entries = [entry];
                }
            }
            else {
                entries.push(entry);
            }
        }
        if (entries.length > 0)
            yield { key: entries[0].key, value: entries.map((e) => e.value) };
    }
    /**
     * iterate through the values
     * @returns - an iterator
     */
    [Symbol.asyncIterator]() {
        return this.entries();
    }
    /** Closes the store */
    close() {
        this.#store.close(true);
    }
}
//# sourceMappingURL=mmap.js.map