@metamask/kernel-store
Version:
Ocap Kernel storage abstractions and implementations
27 lines • 1.1 kB
text/typescript
import type { Database as SqliteDatabase } from "better-sqlite3";
import type { KernelDatabase } from "../types.mjs";
export type Database = SqliteDatabase & {
_spStack: string[];
};
/**
* Makes a {@link KernelDatabase} for low-level persistent storage.
*
* @param options - The options for the database.
* @param options.dbFilename - The filename of the database to use. Defaults to {@link DEFAULT_DB_FILENAME}.
* @param options.label - A logger prefix label. Defaults to '[sqlite]'.
* @param options.verbose - If true, generate logger output; if false, be quiet.
* @returns The key/value store to base the kernel store on.
*/
export declare function makeSQLKernelDatabase({ dbFilename, label, verbose, }: {
dbFilename?: string | undefined;
label?: string | undefined;
verbose?: boolean | undefined;
}): Promise<KernelDatabase>;
/**
* Get the filename for a database.
*
* @param label - A label for the database.
* @returns The filename for the database.
*/
export declare function getDBFilename(label: string): Promise<string>;
//# sourceMappingURL=nodejs.d.mts.map