fastkv 0.2.0 → 1.0.0

package/README.md

@@ -6,8 +6,9 @@
 
 FastKV is a key-value store which offers the following features:
 
-- Persistent storage in JSON files 📁
-- Caching with in-memory storage 🕒
+- Supports temporary in-memory storage 🕒
+- Supports persistent storage with JSON files 📁
+- Lightweight with no dependencies ⚡
 
 ## Installation
 
@@ -28,19 +29,20 @@ import { KV } from 'fastkv';
 
 // For TypeScript users, the KV supports generics:
 // const example = new KV<string>();
+// Or: example.get<string>('my-key-name');
 
 const kv = new KV('./db.json'); // Save the data. Path resolves with process.cwd()
 const cache = new KV('::memory::'); // Keep the data in the system's memory.
 
 // Set data
-await kv.set('userSettings', { theme: 'dark' }); // => Promise<KV>
+kv.set('userSettings', { theme: 'dark' }); // -> KV
 
 // Retreive data by a key
-await kv.get('userSettings'); // => Promise resolving to { theme: 'dark' }
+kv.get('userSettings'); // -> { theme: 'dark' }
 
 // Retreive all data
-await kv.all(); // => Promise resolving an array: [{ key: 'userSettings', value: { theme: 'dark' } }]
+kv.all(); // -> [{ key: 'userSettings', value: { theme: 'dark' } }]
 
 // Clear the store
-await kv.clear(); // => Promise<KV>
+kv.clear(); // -> KV
 ```

package/dist/index.d.mts

@@ -1,3 +1,7 @@
+type Entry<T> = {
+    key: string;
+    value: T;
+};
 /**
  * Represents a key-value store.
  * Initializing with `::memory::` uses in-memory storage.
@@ -22,12 +26,12 @@ declare class KV<T = any> {
      * @param key - The existing key's name.
      * @returns The found data, or null.
      */
-    get(key: string): T | null;
+    get<U = T>(key: string): U | null;
     /**
      * Gets all data in the store.
-     * @returns An array of data.
+     * @returns An array of Entry objects [{ key: string, value: T }].
      */
-    all(): T[];
+    all(): Entry<T>[];
     /**
      * Clears all data in the store.
      * @returns The KV instance.

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+type Entry<T> = {
+    key: string;
+    value: T;
+};
 /**
  * Represents a key-value store.
  * Initializing with `::memory::` uses in-memory storage.
@@ -22,12 +26,12 @@ declare class KV<T = any> {
      * @param key - The existing key's name.
      * @returns The found data, or null.
      */
-    get(key: string): T | null;
+    get<U = T>(key: string): U | null;
     /**
      * Gets all data in the store.
-     * @returns An array of data.
+     * @returns An array of Entry objects [{ key: string, value: T }].
      */
-    all(): T[];
+    all(): Entry<T>[];
     /**
      * Clears all data in the store.
      * @returns The KV instance.

package/dist/index.js

@@ -1 +1 @@
-"use strict";var a=Object.create;var e=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var f=Object.getPrototypeOf,d=Object.prototype.hasOwnProperty;var y=(r,t)=>{for(var i in t)e(r,i,{get:t[i],enumerable:!0})},o=(r,t,i,c)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of p(t))!d.call(r,s)&&s!==i&&e(r,s,{get:()=>t[s],enumerable:!(c=m(t,s))||c.enumerable});return r};var l=(r,t,i)=>(i=r!=null?a(f(r)):{},o(t||!r||!r.__esModule?e(i,"default",{value:r,enumerable:!0}):i,r)),g=r=>o(e({},"__esModule",{value:!0}),r);var b={};y(b,{KV:()=>n,default:()=>T});module.exports=g(b);var h=l(require("fs")),u=l(require("path")),n=class{#t;#r;constructor(t="::memory::"){this.#t=t,this.#r={},t!="::memory::"&&(this.#t=u.default.resolve(process.cwd(),this.#t),this.#r=this.#s())}#s(){if(this.#t==="::memory::")return{};try{let t=h.default.readFileSync(this.#t,"utf8");return JSON.parse(t)||{}}catch{return{}}}#i(){this.#t!=="::memory::"&&h.default.writeFileSync(this.#t,JSON.stringify(this.#r),"utf8")}set(t,i){return this.#r[t]=i,this.#i(),i}get(t){return this.#r[t]??null}all(){return Object.values(this.#r)}clear(){return this.#r={},this.#i(),this}},T=new n;0&&(module.exports={KV});
+"use strict";var l=Object.create;var e=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var y=Object.getPrototypeOf,f=Object.prototype.hasOwnProperty;var d=(r,t)=>{for(var i in t)e(r,i,{get:t[i],enumerable:!0})},c=(r,t,i,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of m(t))!f.call(r,s)&&s!==i&&e(r,s,{get:()=>t[s],enumerable:!(o=p(t,s))||o.enumerable});return r};var u=(r,t,i)=>(i=r!=null?l(y(r)):{},c(t||!r||!r.__esModule?e(i,"default",{value:r,enumerable:!0}):i,r)),g=r=>c(e({},"__esModule",{value:!0}),r);var b={};d(b,{KV:()=>n,default:()=>T});module.exports=g(b);var h=u(require("fs")),a=u(require("path")),n=class{#t;#r;constructor(t="::memory::"){this.#t=t,this.#r={},t!=="::memory::"&&(this.#t=a.default.resolve(process.cwd(),this.#t),this.#r=this.#s())}#s(){if(this.#t==="::memory::")return{};try{let t=h.default.readFileSync(this.#t,"utf8");return JSON.parse(t)||{}}catch{return{}}}#i(){this.#t!=="::memory::"&&h.default.writeFileSync(this.#t,JSON.stringify(this.#r),"utf8")}set(t,i){return this.#r[t]=i,this.#i(),i}get(t){return this.#r[t]??null}all(){return Object.entries(this.#r).map(([t,i])=>({key:t,value:i}))}clear(){return this.#r={},this.#i(),this}},T=new n;0&&(module.exports={KV});

package/dist/index.mjs

@@ -1 +1 @@
-import s from"node:fs";import e from"node:path";var r=class{#t;#r;constructor(t="::memory::"){this.#t=t,this.#r={},t!="::memory::"&&(this.#t=e.resolve(process.cwd(),this.#t),this.#r=this.#s())}#s(){if(this.#t==="::memory::")return{};try{let t=s.readFileSync(this.#t,"utf8");return JSON.parse(t)||{}}catch{return{}}}#i(){this.#t!=="::memory::"&&s.writeFileSync(this.#t,JSON.stringify(this.#r),"utf8")}set(t,i){return this.#r[t]=i,this.#i(),i}get(t){return this.#r[t]??null}all(){return Object.values(this.#r)}clear(){return this.#r={},this.#i(),this}},u=new r;export{r as KV,u as default};
+import s from"node:fs";import e from"node:path";var i=class{#t;#r;constructor(t="::memory::"){this.#t=t,this.#r={},t!=="::memory::"&&(this.#t=e.resolve(process.cwd(),this.#t),this.#r=this.#s())}#s(){if(this.#t==="::memory::")return{};try{let t=s.readFileSync(this.#t,"utf8");return JSON.parse(t)||{}}catch{return{}}}#i(){this.#t!=="::memory::"&&s.writeFileSync(this.#t,JSON.stringify(this.#r),"utf8")}set(t,r){return this.#r[t]=r,this.#i(),r}get(t){return this.#r[t]??null}all(){return Object.entries(this.#r).map(([t,r])=>({key:t,value:r}))}clear(){return this.#r={},this.#i(),this}},a=new i;export{i as KV,a as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastkv",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "publishConfig": {
     "access": "public"
   },