leaf-db/dist/leafdb.d.ts

Small file-based database for node.js

export type StorageOptions = {
	name: string;
	dir: string;
};
declare class Storage$1 {
	#private;
	constructor(options: StorageOptions);
	open(): Promise<string[]>;
	close(): Promise<void>;
	write(x: string): Promise<void>;
	append(x: string): Promise<void>;
	flush(): Promise<void>;
}
export type Json = string | number | boolean | null | Json[] | {
	[key: string]: Json;
};
export type Draft = Record<string, Json> & {
	[key: `$${string}`]: never;
	[key: `__${string}`]: never;
};
export type Doc<T extends Draft> = T & {
	readonly _id: string;
};
type Operator<T extends Record<string, Json>> = {
	[K in keyof T]?: T[K] extends number ? Partial<T[K]> | {
		$gt: number;
	} | {
		$gte: number;
	} | {
		$lt: number;
	} | {
		$lte: number;
	} : T[K] extends string ? Partial<T[K]> | {
		$regexp: RegExp;
	} : T[K] extends unknown[] ? Partial<T[K]> | {
		$length: number;
	} | {
		$includes: unknown;
	} : T[K] extends Record<string, Json> ? Partial<T[K]> | Operator<T[K]> : Partial<T[K]>;
};
export type Query<T extends Draft> = {
	$not?: Query<T>;
	$or?: Array<Query<T>>;
	$and?: Array<Query<T>>;
} | Operator<T>;
export type Corrupt = {
	raw: string;
	error: Error;
};
declare class LeafDB<T extends Draft> {
	#private;
	constructor();
	/** Get all documents */
	get docs(): Array<Doc<T>>;
	/** Read existing file and store to internal memory */
	open(storage: Storage$1): Promise<Corrupt[]>;
	/** Close file */
	close(): Promise<void | undefined>;
	/** Get document by `id` */
	get(id: string): Doc<T> | null;
	/** Create new document, throws if document already exists */
	insert(draft: T & {
		_id?: string;
	}): Promise<Doc<T>>;
	/** Find document by query */
	query(query: Query<T>): Array<Doc<T>>;
	/** Update document, throws if document does not exist */
	update(doc: Doc<T>): Promise<void>;
	/** Delete document by `id` */
	delete(id: string): Promise<void>;
	/** Delete all documents */
	drop(): Promise<void>;
}

export {
	LeafDB as default,
};

export {};