ueberdb2 5.0.48 → 6.0.2

package/dist/index.d.ts

@@ -1,99 +1,52 @@
-import { Settings } from './lib/AbstractDatabase';
-export type DatabaseType = 'mysql' | 'postgres' | 'sqlite' | 'rustydb' | 'mongodb' | 'redis' | 'cassandra' | 'dirty' | 'dirtygit' | 'elasticsearch' | 'memory' | 'mock' | 'mssql' | 'postgrespool' | 'rethink' | 'couch' | 'surrealdb';
+/**
+ * 2011 Peter 'Pita' Martischka
+ * 2020 John McLear
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS-IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Database as DatabaseCache, type Metrics } from './lib/CacheAndBufferLayer';
+import { normalizeLogger } from './lib/logging';
+import type { Settings } from './lib/AbstractDatabase';
+export type { Settings } from './lib/AbstractDatabase';
+export type { Metrics, CacheSettings } from './lib/CacheAndBufferLayer';
+export type { Logger } from './lib/logging';
+export type DatabaseType = 'cassandra' | 'couch' | 'dirty' | 'dirtygit' | 'elasticsearch' | 'memory' | 'mock' | 'mongodb' | 'mssql' | 'mysql' | 'postgres' | 'postgrespool' | 'redis' | 'rethink' | 'rustydb' | 'sqlite' | 'surrealdb';
 export declare class Database {
     readonly type: DatabaseType;
-    readonly dbSettings: any;
-    readonly wrapperSettings: any | {};
-    readonly logger: Function | null;
-    db: any;
-    metrics: any;
+    readonly dbSettings: Settings | null | string;
+    readonly wrapperSettings: Record<string, unknown> | null;
+    private readonly _logger;
+    db: DatabaseCache;
+    metrics: Metrics;
     /**
      * @param type The type of the database
      * @param dbSettings The settings for that specific database type
-     * @param wrapperSettings
-     * @param logger Optional logger object. If no logger object is provided no logging will occur.
-     *     The logger object is expected to be a log4js logger object or `console`. A logger object
-     *     from another logging library should also work, but performance may be reduced if the logger
-     *     object does not have is${Level}Enabled() methods (isDebugEnabled(), etc.).
-     */
-    constructor(type: undefined | DatabaseType, dbSettings: Settings | null | string, wrapperSettings?: null | {}, logger?: any);
-    /**
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    init(callback?: null): any;
-    initDB(): Promise<import("./databases/cassandra_db").default | import("./databases/mysql_db").default | import("./databases/postgres_db").default | import("./databases/sqlite_db").default | import("./databases/rusty_db").default | import("./databases/mongodb_db").default | import("./databases/redis_db").default | import("./databases/dirty_db").default | import("./databases/dirty_git_db").default | import("./databases/elasticsearch_db").default | import("./databases/memory_db").default | import("./databases/mock_db").default | import("./databases/mssql_db").default | import("./databases/rethink_db").default | import("./databases/couch_db").default | import("./databases/surrealdb_db").default>;
-    /**
-     * Wrapper functions
-     */
-    /**
-     * Deprecated synonym of flush().
-     *
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    doShutdown(callback?: null): any;
-    /**
-     * Writes any unsaved changes to the underlying database.
-     *
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    flush(callback?: null): any;
-    /**
-     * @param key
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    get(key: string, callback?: null): any;
-    /**
-     * @param key
-     * @param notKey
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    findKeys(key: string, notKey?: string, callback?: null): any;
-    /**
-     * Removes an entry from the database if present.
-     *
-     * @param key
-     * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-     *     underlying database driver. If null, a Promise is returned.
-     * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-     */
-    remove(key: string, cb?: null, deprecated?: null): any;
-    /**
-     * Adds or changes the value of an entry.
-     *
-     * @param key
-     * @param value
-     * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-     *     underlying database driver. If null, a Promise is returned.
-     * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-     */
-    set(key: string, value: any, cb?: null, deprecated?: null): any;
-    /**
-     * @param key
-     * @param sub
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    getSub(key: string, sub: string[], callback?: Function | null): any;
-    /**
-     * Adds or changes a subvalue of an entry.
-     *
-     * @param key
-     * @param sub
-     * @param value
-     * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-     *     underlying database driver. If null, a Promise is returned.
-     * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-     */
-    setSub(key: string, sub: string, value: string, cb?: Function | null, deprecated?: Function | null): any;
-    /**
-     * Flushes unwritten changes then closes the connection to the underlying database. After this
-     * returns, any future call to a method on this object may result in an error.
-     *
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    close(callback?: Function | null): any;
+     * @param wrapperSettings Cache/buffer layer settings (cache size, write interval, etc.)
+     * @param logger Optional logger (log4js, console, or any object with debug/info/warn/error methods)
+     */
+    constructor(type: DatabaseType | undefined, dbSettings: Settings | null | string, wrapperSettings?: Record<string, unknown> | null, logger?: Partial<ReturnType<typeof normalizeLogger>> | null);
+    init(): Promise<void>;
+    private initDB;
+    flush(): Promise<void>;
+    /** @deprecated Use flush() */
+    doShutdown(): Promise<void>;
+    get(key: string): Promise<unknown>;
+    findKeys(key: string, notKey?: string): Promise<string[]>;
+    remove(key: string): Promise<void>;
+    set(key: string, value: unknown): Promise<void>;
+    getSub(key: string, sub: string[]): Promise<unknown>;
+    setSub(key: string, sub: string[], value: unknown): Promise<void>;
+    close(): Promise<void>;
 }
-/**
- * Deprecated synonym of Database.
- */
 export default Database;
 //# sourceMappingURL=index.d.ts.map