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

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

import type { S2CellId } from '../..';
import type { MMEntry, MultiMapStore } from '.';
import type { Properties, Value } from '../..';
/**
 * # 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 declare class MMapMultiMap<V = Properties | Value> implements MultiMapStore<V> {
    #private;
    /**
     * Builds a new MultiMap file store
     * @param fileName - the path + file name without the extension
     */
    constructor(fileName?: string);
    /** @returns - the length of the map */
    get length(): number;
    /**
     * Adds a value to the list of values associated with a key
     * @param key - the key
     * @param value - the value to store
     */
    set(key: number | S2CellId, value: V): void;
    /**
     * Check if the key exists
     * @param key - the key
     * @returns true if the key exists
     */
    has(key: number | S2CellId): Promise<boolean>;
    /**
     * 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
     */
    get(key: number | S2CellId): Promise<V[] | undefined>;
    /**
     * iterate through the values
     * @yields - The values in the store
     */
    entries(): AsyncGenerator<MMEntry<V>>;
    /**
     * iterate through the values
     * @returns - an iterator
     */
    [Symbol.asyncIterator](): AsyncGenerator<MMEntry<V>>;
    /** Closes the store */
    close(): void;
}
//# sourceMappingURL=mmap.d.ts.map