1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
// Copyright 2020-2021 the AloeDB authors. All rights reserved. MIT license.
/** * Database initialization config */export interface DatabaseConfig {	/** Path to the database file. If undefined, data will be stored only in-memory. _(Default: undefined)_ */	path?: string;
	/** Save data in easy-to-read format. _(Default: true)_ */	pretty: boolean;
	/** Automatically load the file synchronously when initializing the database. _(Default: true)_ */	autoload: boolean;
	/**	 * Automatically save data to the file after inserting, updating and deleting documents.	 * If `path` specified, data will be read from the file, but new data will not be written.	 */	autosave: boolean;
	/** Automatically deeply clone all returned objects. _(Default: true)_ */	immutable: boolean;
	/**	 * Optimize data writing. If enabled, the data will be written many times faster in case of a large number of operations.	 * Disable it if you want the methods to be considered executed only when the data is written to a file. _(Default: true)_	 */	optimize: boolean;
	/**	 * Runtime documents validation function.	 * If the document does not pass the validation, just throw the error.	 * Works well with [Superstruct](https://github.com/ianstormtaylor/superstruct)!	 */	validator?: Validator;}
/** Checking the object for suitability for storage. */export type Acceptable<T extends Document> = { [K in keyof T]: T[K] & DocumentValue };
/** Any document-like object. */export type Document = { [key: string]: DocumentValue };
/** Array of document values. */export type DocumentArray = DocumentValue[];
/** Supported documents values. */export type DocumentValue = DocumentPrimitive | Document | DocumentArray;
/** Supported primitives. */export type DocumentPrimitive = string | number | boolean | null;
/** Documents selection criteria. */export type Query<T extends Document = Document> = { [K in keyof T]?: QueryValue<T[K]> };
/** Manual вocuments selection function. */export type QueryFunction<T extends Document = Document> = (document: Readonly<T>) => boolean;
/** Possible search query values. */export type QueryValue<T extends DocumentValue = DocumentValue> = DocumentValue | ((value: Readonly<T>) => boolean) | RegExp | undefined;
/** The modifications to apply. */export type Update<T extends Document = Document> = { [K in keyof T]?: UpdateValue<T[K]> };
/** Manual modifications applying. */export type UpdateFunction<T extends Document = Document> = (document: T) => T | null;
/** Possible update values. */export type UpdateValue<T extends DocumentValue = DocumentValue> = T | ((value: T) => T) | undefined;
/** Schema validation. Throw error, if document unsuitable.  */export type Validator = (document: Readonly<Document>) => void;