enmap/dist/index.d.ts

A simple database wrapper to make sqlite database interactions much easier for beginners, with additional array helper methods.

import Database from 'better-sqlite3';
export interface EnmapOptions<V = unknown, SV = unknown> {
    name?: string;
    dataDir?: string;
    ensureProps?: boolean;
    autoEnsure?: V;
    serializer?: (value: V, key: string) => SV;
    deserializer?: (value: SV, key: string) => V;
    inMemory?: boolean;
    sqliteOptions?: Database.Options;
}
type MathOps = 'add' | 'addition' | '+' | 'sub' | 'subtract' | '-' | 'mult' | 'multiply' | '*' | 'div' | 'divide' | '/' | 'exp' | 'exponent' | '^' | 'mod' | 'modulo' | '%' | 'rand' | 'random';
type PathImpl<T, K extends keyof T> = K extends string ? NonNullable<T[K]> extends Record<string, unknown> ? K | `${K}.${PathImpl<NonNullable<T[K]>, keyof NonNullable<T[K]>>}` : K : never;
type Path<T> = PathImpl<T, keyof T>;
type PathValue<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? PathValue<NonNullable<T[K]>, Rest> : never : P extends keyof T ? T[P] : never;
/**
 * A simple, synchronous, fast key/value storage build around better-sqlite3.
 * Contains extra utility methods for managing arrays and objects.
 */
export default class Enmap<V = any, SV = unknown> {
    #private;
    /**
     * Initializes a new Enmap, with options.
     * @param options Options for the enmap. See https://enmap.alterion.dev/usage#enmap-options for details.
     * @param options.name The name of the enmap. Represents its table name in sqlite. Unless inMemory is set to true, the enmap will be persisted to disk.
     * @param options.dataDir Defaults to `./data`. Determines where the sqlite files will be stored. Can be relative (to your project root) or absolute on the disk. Windows users , remember to escape your backslashes! *Note*: Enmap will not automatically create the folder if it is set manually, so make sure it exists before starting your code!
     * @param options.ensureProps defaults to `true`. If enabled and the value in the enmap is an object, using ensure() will also ensure that every property present in the default object will be added to the value, if it's absent. See ensure API reference for more information.
     * @param options.autoEnsure default is disabled. When provided a value, essentially runs ensure(key, autoEnsure) automatically so you don't have to. This is especially useful on get(), but will also apply on set(), and any array and object methods that interact with the database.
     * @param options.serializer Optional. If a function is provided, it will execute on the data when it is written to the database. This is generally used to convert the value into a format that can be saved in the database, such as converting a complete class instance to just its ID. This function may return the value to be saved, or a promise that resolves to that value (in other words, can be an async function).
     * @param options.deserializer Optional. If a function is provided, it will execute on the data when it is read from the database. This is generally used to convert the value from a stored ID into a more complex object. This function may return a value, or a promise that resolves to that value (in other words, can be an async function).
     * @param options.inMemory Optional. If set to true, the enmap will be in-memory only, and will not write to disk. Useful for temporary stores.
     * @param options.sqliteOptions Optional. An object of options to pass to the better-sqlite3 Database constructor.
     * @example
     * import Enmap from 'enmap';
     * // Named, Persistent enmap
     * const myEnmap = new Enmap({ name: "testing" });
     *
     * // Memory-only enmap
     * const memoryEnmap = new Enmap({ inMemory: true });
     *
     * // Enmap that automatically assigns a default object when getting or setting anything.
     * const autoEnmap = new Enmap({name: "settings", autoEnsure: { setting1: false, message: "default message"}})
     */
    constructor(options: EnmapOptions<V, SV>);
    /**
     * Sets a value in Enmap. If the key already has a value, overwrites the data (or the value in a path, if provided).
     * @param key Required. The location in which the data should be saved.
     * @param value Required. The value to write. Values must be serializable, which is done through (better-serialize)[https://github.com/RealShadowNova/better-serialize] If the value is not directly serializable, please use a custom serializer/deserializer.
     * @param path Optional. The path to the property to modify inside the value object or array. Should be a path with dot notation, such as "prop1.subprop2.subprop3"
     * @example
     * // Direct Value Examples
     * enmap.set('simplevalue', 'this is a string');
     * enmap.set('isEnmapGreat', true);
     * enmap.set('TheAnswer', 42);
     * enmap.set('IhazObjects', { color: 'black', action: 'paint', desire: true });
     * enmap.set('ArraysToo', [1, "two", "tree", "foor"])
     *
     * // Settings Properties
     * enmap.set('IhazObjects', 'blue', 'color'); //modified previous object
     * enmap.set('ArraysToo', 'three', 2); // changes "tree" to "three" in array.
     */
    set(key: string, value: any, path?: Path<V>): this;
    /**
     * Retrieves a value from the enmap, using its key.
     * @param key The key to retrieve from the enmap.
     * @param path Optional. The property to retrieve from the object or array. Should be a path with dot notation, such as "prop1.subprop2.subprop3"
     * @returns {*} The parsed value for this key.
     * @example
     * const myKeyValue = enmap.get("myKey");
     * console.log(myKeyValue);
     *
     * const someSubValue = enmap.get("anObjectKey", "someprop.someOtherSubProp");
     */
    get(key: string): V | null;
    get<P extends Path<V>>(key: string, path: P): PathValue<V, P> | null;
    get<P extends Path<V>>(key: string, path: P | undefined): V | PathValue<V, P> | null;
    /**
     * Returns whether or not the key exists in the Enmap.
     * @param key Required. The key of the element to add to The Enmap or array.
     * @example
     * if(enmap.has("myKey")) {
     *   // key is there
     * }
     * @returns {boolean}
     */
    has(key: string): boolean;
    /**
     * Deletes a key in the Enmap.
     * @param key Required. The key of the element to delete from The Enmap.
     * @param path Optional. The name of the property to remove from the object. Should be a path with dot notation, such as "prop1.subprop2.subprop3"
     */
    delete(key: string, path?: Path<V>): this;
    /**
     * Deletes everything from the enmap.
     * @returns {void}
     */
    clear(): void;
    /**
     * Get the number of key/value pairs saved in the enmap.
     * @readonly
     * @returns {number} The number of elements in the enmap.
     */
    get size(): number;
    get count(): number;
    get length(): number;
    /**
     * Get the better-sqlite3 database object. Useful if you want to directly query or interact with the
     * underlying SQLite database. Use at your own risk, as errors here might cause loss of data or corruption!
     * @return {Database}
     */
    get db(): Database.Database;
    /**
     * Generates an automatic numerical key for inserting a new value.
     * This is a "weak" method, it ensures the value isn't duplicated, but does not
     * guarantee it's sequential (if a value is deleted, another can take its place).
     * Useful for logging, actions, items, etc - anything that doesn't already have a unique ID.
     * @readonly
     * @example
     * enmap.set(enmap.autonum, "This is a new value");
     * @return {string} The generated key number.
     */
    get autonum(): string;
    /**
     * Get all the keys of the enmap as an array.
     * @returns {Array<string>} An array of all the keys in the enmap.
     */
    keys(): string[];
    indexes(): string[];
    /**
     * Get all the values of the enmap as an array.
     * @returns {Array<*>} An array of all the values in the enmap.
     */
    values(): V[];
    /**
     * Get all entries of the enmap as an array, with each item containing the key and value.
     * @returns {Array<Array<*,*>>} An array of arrays, with each sub-array containing two items, the key and the value.
     */
    entries(): [string, V][];
    /**
     * Update an existing object value in Enmap by merging new keys. **This only works on objects**, any other value will throw an error.
     * Heavily inspired by setState from React's class components.
     * This is very useful if you have many different values to update and don't want to have more than one .set(key, value, prop) lines.
     * @param {string} key The key of the object to update.
     * @param {*} valueOrFunction Either an object to merge with the existing value, or a function that provides the existing object
     * and expects a new object as a return value. In the case of a straight value, the merge is recursive and will add any missing level.
     * If using a function, it is your responsibility to merge the objects together correctly.
     * @example
     * // Define an object we're going to update
     * enmap.set("obj", { a: 1, b: 2, c: 3 });
     *
     * // Direct merge
     * enmap.update("obj", { d: 4, e: 5 });
     * // obj is now { a: 1, b: 2, c: 3, d: 4, e: 5 }
     *
     * // Functional update
     * enmap.update("obj", (previous) => ({
     *   ...obj,
     *   f: 6,
     *   g: 7
     * }));
     * // this example takes heavy advantage of the spread operators.
     * // More info: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax
     * @returns {*} The modified (merged) value.
     */
    update(key: string, valueOrFunction: Partial<V> | ((data: V) => V)): V;
    /**
     * Returns an observable object. Modifying this object or any of its properties/indexes/children
     * will automatically save those changes into enmap. This only works on
     * objects and arrays, not "basic" values like strings or integers.
     * @param {*} key The key to retrieve from the enmap.
     * @param {string} path Optional. The property to retrieve from the object or array.
     * @return {*} The value for this key.
     */
    observe(key: string): V;
    observe<P extends Path<V>>(key: string, path: P): PathValue<V, P>;
    /**
     * Push to an array value in Enmap.
     * @param {string} key Required. The key of the array element to push to in Enmap.
     * @param {*} value Required. The value to push to the array.
     * @param {string} path Optional. The path to the property to modify inside the value object or array.
     * Should be a path with dot notation, such as "prop1.subprop2.subprop3"
     * @param {boolean} allowDupes Optional. Allow duplicate values in the array (default: false).
     * @example
     * // Assuming
     * enmap.set("simpleArray", [1, 2, 3, 4]);
     * enmap.set("arrayInObject", {sub: [1, 2, 3, 4]});
     *
     * enmap.push("simpleArray", 5); // adds 5 at the end of the array
     * enmap.push("arrayInObject", "five", "sub"); // adds "five" at the end of the sub array
     */
    push(key: string, value: V, path?: Path<V>, allowDupes?: boolean): this;
    /**
     * Executes a mathematical operation on a value and saves it in the enmap.
     * @param {string} key The enmap key on which to execute the math operation.
     * @param {string} operation Which mathematical operation to execute. Supports most
     * math ops: =, -, *, /, %, ^, and english spelling of those operations.
     * @param {number} operand The right operand of the operation.
     * @param {string} path Optional. The property path to execute the operation on, if the value is an object or array.
     * @example
     * // Assuming
     * points.set("number", 42);
     * points.set("numberInObject", {sub: { anInt: 5 }});
     *
     * points.math("number", "/", 2); // 21
     * points.math("number", "add", 5); // 26
     * points.math("number", "modulo", 3); // 2
     * points.math("numberInObject", "+", 10, "sub.anInt");
     * @returns {number} The updated value after the operation
     */
    math(key: string, operation: MathOps, operand: number, path?: Path<V>): number | null;
    /**
     * Increments a key's value or property by 1. Value must be a number, or a path to a number.
     * @param {string} key The enmap key where the value to increment is stored.
     * @param {string} path Optional. The property path to increment, if the value is an object or array.
     * @example
     * // Assuming
     * points.set("number", 42);
     * points.set("numberInObject", {sub: { anInt: 5 }});
     *
     * points.inc("number"); // 43
     * points.inc("numberInObject", "sub.anInt"); // {sub: { anInt: 6 }}
     * @returns {number} The udpated value after incrementing.
     */
    inc(key: string, path?: Path<V>): this;
    /**
     * Decrements a key's value or property by 1. Value must be a number, or a path to a number.
     * @param {string} key The enmap key where the value to decrement is stored.
     * @param {string} path Optional. The property path to decrement, if the value is an object or array.
     * @example
     * // Assuming
     * points.set("number", 42);
     * points.set("numberInObject", {sub: { anInt: 5 }});
     *
     * points.dec("number"); // 41
     * points.dec("numberInObject", "sub.anInt"); // {sub: { anInt: 4 }}
     * @returns {Enmap} The enmap.
     */
    dec(key: string, path?: Path<V>): this;
    /**
     * Returns the key's value, or the default given, ensuring that the data is there.
     * This is a shortcut to "if enmap doesn't have key, set it, then get it" which is a very common pattern.
     * @param {string} key Required. The key you want to make sure exists.
     * @param {*} defaultValue Required. The value you want to save in the database and return as default.
     * @param {string} path Optional. If presents, ensures both the key exists as an object, and the full path exists.
     * Should be a path with dot notation, such as "prop1.subprop2.subprop3"
     * @example
     * // Simply ensure the data exists (for using property methods):
     * enmap.ensure("mykey", {some: "value", here: "as an example"});
     * enmap.has("mykey"); // always returns true
     * enmap.get("mykey", "here") // returns "as an example";
     *
     * // Get the default value back in a variable:
     * const settings = mySettings.ensure("1234567890", defaultSettings);
     * console.log(settings) // enmap's value for "1234567890" if it exists, otherwise the defaultSettings value.
     * @return {*} The value from the database for the key, or the default value provided for a new key.
     */
    ensure(key: string, defaultValue: any): V | null;
    ensure<P extends Path<V>>(key: string, defaultValue: any, path: P): PathValue<V, P> | null;
    /**
     * Performs Array.includes() on a certain enmap value. Works similar to
     * [Array.includes()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes).
     * @param {string} key Required. The key of the array to check the value of.
     * @param {string|number} value Required. The value to check whether it's in the array.
     * @param {string} path Optional. The property to access the array inside the value object or array.
     * Should be a path with dot notation, such as "prop1.subprop2.subprop3"
     * @return {boolean} Whether the array contains the value.
     */
    includes(key: string, value: V, path?: Path<V>): boolean;
    /**
     * Remove a value in an Array or Object element in Enmap. Note that this only works for
     * values, not keys. Note that only one value is removed, no more. Arrays of objects must use a function to remove,
     * as full object matching is not supported.
     * @param {string} key Required. The key of the element to remove from in Enmap.
     * @param {*|Function} val Required. The value to remove from the array or object. OR a function to match an object.
     * If using a function, the function provides the object value and must return a boolean that's true for the object you want to remove.
     * @param {string} path Optional. The name of the array property to remove from.
     * Should be a path with dot notation, such as "prop1.subprop2.subprop3".
     * If not presents, removes directly from the value.
     * @example
     * // Assuming
     * enmap.set('array', [1, 2, 3])
     * enmap.set('objectarray', [{ a: 1, b: 2, c: 3 }, { d: 4, e: 5, f: 6 }])
     *
     * enmap.remove('array', 1); // value is now [2, 3]
     * enmap.remove('objectarray', (value) => value.e === 5); // value is now [{ a: 1, b: 2, c: 3 }]
     */
    remove(key: string, val: V | ((value: V) => boolean), path?: Path<V>): this;
    /**
     * Exports the enmap data to stringified JSON format.
     * **__WARNING__**: Does not work on memory enmaps containing complex data!
     * @returns {string} The enmap data in a stringified JSON format.
     */
    export(): string;
    /**
     * Import an existing json export from enmap. This data must have been exported from enmap,
     * and must be from a version that's equivalent or lower than where you're importing it.
     * (This means Enmap 5 data is compatible in Enmap 6).
     * @param {string} data The data to import to Enmap. Must contain all the required fields provided by an enmap export().
     * @param {boolean} overwrite Defaults to `true`. Whether to overwrite existing key/value data with incoming imported data
     * @param {boolean} clear Defaults to `false`. Whether to clear the enmap of all data before importing
     * (**__WARNING__**: Any existing data will be lost! This cannot be undone.)
     */
    import(data: string, overwrite?: boolean, clear?: boolean): this;
    /**
     * Initialize multiple Enmaps easily.
     * @param {Array<string>} names Array of strings. Each array entry will create a separate enmap with that name.
     * @param {Object} options Options object to pass to each enmap, excluding the name..
     * @example
     * // Using local variables.
     * import Enmap from 'enmap';
     * const { settings, tags, blacklist } = Enmap.multi(['settings', 'tags', 'blacklist']);
     *
     * // Attaching to an existing object (for instance some API's client)
     * import Enmap from 'enmap';
     * Object.assign(client, Enmap.multi(["settings", "tags", "blacklist"]));
     *
     * @returns {Object} An array of initialized Enmaps.
     */
    static multi<V = unknown, SV = unknown>(names: string[], options?: Omit<EnmapOptions<V, SV>, 'name'>): Record<string, Enmap<V, SV>>;
    /**
     * Obtains random value(s) from this Enmap. This relies on {@link Enmap#array}.
     * @param {number} [count] Number of values to obtain randomly
     * @returns {*|Array<*>} The single value if `count` is undefined,
     * or an array of values of `count` length
     */
    random(count?: number): [string, V][];
    /**
     * Obtains random key(s) from this Enmap. This relies on {@link Enmap#keyArray}
     * @param {number} [count] Number of keys to obtain randomly
     * @returns {*|Array<*>} The single key if `count` is undefined,
     * or an array of keys of `count` length
     */
    randomKey(count?: number): string[];
    /**
     * Similar to
     * [Array.every()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every).
     * Supports either a predicate function or a value to compare.
     * Returns true only if the predicate function returns true for all elements in the array (or the value is strictly equal in all elements).
     * @param {Function | string} valueOrFunction Function used to test (should return a boolean), or a value to compare.
     * @param {string} [path] Required if the value is an object. The path to the property to compare with.
     * @returns {boolean}
     */
    every(valueOrFunction: ((val: V, key: string) => boolean) | any, path?: Path<V>): boolean;
    /**
     * Similar to
     * [Array.some()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some).
     * Supports either a predicate function or a value to compare.
     * Returns true if the predicate function returns true for at least one element in the array (or the value is equal in at least one element).
     * @param {Function | string} valueOrFunction Function used to test (should return a boolean), or a value to compare.
     * @param {string} [path] Required if the value is an object. The path to the property to compare with.
     * @returns {Array}
     */
    some(valueOrFunction: ((val: V, key: string) => boolean) | any, path?: Path<V>): boolean;
    /**
     * Similar to
     * [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).
     * Returns an array of the results of applying the callback to all elements.
     * @param {Function | string} pathOrFn A function that produces an element of the new Array, or a path to the property to map.
     * @returns {Array}
     */
    map<R>(pathOrFn: ((val: V, key: string) => R) | string): R[];
    /**
     * Searches for a single item where its specified property's value is identical to the given value
     * (`item[prop] === value`), or the given function returns a truthy value. In the latter case, this is similar to
     * [Array.find()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find).
     * @param {string|Function} pathOrFn The path to the value to test against, or the function to test with
     * @param {*} [value] The expected value - only applicable and required if using a property for the first argument
     * @returns {*}
     * @example
     * enmap.find('username', 'Bob');
     * @example
     * enmap.find(val => val.username === 'Bob');
     */
    find(pathOrFn: ((val: V, key: string) => boolean) | string, value?: any): V | null;
    /**
     * Searches for the key of a single item where its specified property's value is identical to the given value
     * (`item[prop] === value`), or the given function returns a truthy value. In the latter case, this is similar to
     * [Array.findIndex()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex).
     * @param {string|Function} pathOrFn The path to the value to test against, or the function to test with
     * @param {*} [value] The expected value - only applicable and required if using a property for the first argument
     * @returns {string|number}
     * @example
     * enmap.findIndex('username', 'Bob');
     * @example
     * enmap.findIndex(val => val.username === 'Bob');
     */
    findIndex(pathOrFn: ((val: V, key: string) => boolean) | string, value?: any): string | null;
    /**
     * Similar to
     * [Array.reduce()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce).
     * @param {Function} predicate Function used to reduce, taking three arguments; `accumulator`, `currentValue`, `currentKey`.
     * @param {*} [initialValue] Starting value for the accumulator
     * @returns {*}
     */
    reduce<R>(predicate: (accumulator: R, val: V, key: string) => R, initialValue: R): R;
    /**
     * Similar to
     * [Array.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter).
     * Returns an array of values where the given function returns true for that value.
     * Alternatively you can provide a value and path to filter by using exact value matching.
     * @param {Function} pathOrFn  The path to the value to test against, or the function to test with.
     * If using a function, this function should return a boolean.
     * @param {string} [value] Value to use as `this` when executing function
     * @returns {Enmap}
     */
    filter(pathOrFn: ((val: V, key: string) => boolean) | string, value?: any): V[];
    /**
     * Deletes entries that satisfy the provided filter function or value matching.
     * @param {Function|string} pathOrFn The path to the value to test against, or the function to test with.
     * @param {*} [value] The expected value - only applicable and required if using a property for the first argument.
     * @returns {number} The number of removed entries.
     */
    sweep(pathOrFn: ((val: V, key: string) => boolean) | string, value?: any): number;
    /**
     * Function called whenever data changes within Enmap after the initial load.
     * Can be used to detect if another part of your code changed a value in enmap and react on it.
     * @example
     * enmap.changed((keyName, oldValue, newValue) => {
     *   console.log(`Value of ${keyName} has changed from: \n${oldValue}\nto\n${newValue}`);
     * });
     * @param {Function} cb A callback function that will be called whenever data changes in the enmap.
     */
    changed(cb: (key: string, oldValue: V | undefined, newValue: V | undefined) => void): void;
    /**
     * Separates the Enmap into multiple arrays given a function that separates them.
     * @param {*} pathOrFn the path to the value to test against, or the function to test with.
     * @param {*} value the value to use as a condition for partitioning.
     * @returns {Array<Array<*>>} An array of arrays with the partitioned data.
     */
    partition(pathOrFn: ((val: V, key: string) => boolean) | string, value?: any): [V[], V[]];
}
export {};
//# sourceMappingURL=index.d.ts.map