updated types for persistance and replaced bun-types with @types/bun

Author: ksamirdev

bun.lockb

@@ -1,44 +1,46 @@
-// Generated by dts-bundle-generator v8.0.1
-
+/**
+ * A class representing a cache using Bun's SQLite.
+ */
 declare class BunCache {
-	private cache;
-	/**
-	 * Creates a new instance of the BunCache class.
-	 */
-	constructor();
-	/**
-	 * Initializes the cache schema.
-	 */
-	private initializeSchema;
-	/**
-	 * Retrieves the value associated with a key from the cache.
-	 * @param key - The key for which to fetch the value.
-	 * @returns The value if the key exists and hasn't expired, `null` otherwise.
-	 */
-	get(key: string): string | object | boolean | null;
-	/**
-	 * Adds a value to the cache.
-	 * @param key - The key under which to store the value.
-	 * @param value - The value to be stored.
-	 * @param ttl - The time-to-live for the value, in milliseconds.
-	 * @returns `true` if the value was successfully stored, `false` otherwise.
-	 */
-	put(key: string, value: string | object | null, ttl: number): boolean;
-	/**
-	 * Removes a key from the cache.
-	 * @param key - The key to be deleted.
-	 * @returns `true` if the key was successfully deleted, `false` otherwise.
-	 */
-	delete(key: string): boolean;
+    private cache;
+    /**
+     * Creates a new instance of the BunCache class.
+     */
+    constructor(persistance?: boolean);
+    /**
+     * Initializes the cache schema.
+     */
+    private initializeSchema;
+    /**
+     * Retrieves the value associated with a key from the cache.
+     * @param key - The key for which to fetch the value.
+     * @returns The value if the key exists and hasn't expired, `null` otherwise.
+     */
+    get(key: string): string | object | boolean | null;
+    /**
+     * Adds a value to the cache.
+     * @param key - The key under which to store the value.
+     * @param value - The value to be stored.
+     * @param ttl - The time-to-live for the value, in milliseconds.
+     * @returns `true` if the value was successfully stored, `false` otherwise.
+     */
+    put(key: string, value: string | object | null, ttl?: number): boolean;
+    /**
+     * Removes a key from the cache.
+     * @param key - The key to be deleted.
+     * @returns `true` if the key was successfully deleted, `false` otherwise.
+     */
+    delete(key: string): boolean;
+    /**
+     * Checks if a key exists in the cache.
+     * @param key - The key to be checked
+     * @returns `true` if the key exists, `false` otherwise
+     */
+    hasKey(key: string): boolean;
 }
+export default BunCache;
 export interface CacheSchema {
-	key: string;
-	value: string | null;
-	ttl: number;
+    key: string;
+    value: string | null;
+    ttl: number | null;
 }
-
-export {
-	BunCache as default,
-};
-
-export {};

dist/index.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@samocodes/bun-cache",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "private": false,
   "author": "Samir <[email protected]>",
   "repository": {
@@ -9,7 +9,7 @@
   "main": "dist/index.js",
   "module": "dist/index.js",
   "devDependencies": {
-    "bun-types": "^1.1.12"
+    "@types/bun": "^1.1.6"
   },
   "peerDependencies": {
     "typescript": "^5.4.5"

package.json

@@ -15,6 +15,6 @@
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
     "allowJs": true,
-    "types": ["bun-types"]
+    "types": ["@types/bun"]
   }
 }