fastkv 0.1.1 → 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.
@@ -14,25 +18,25 @@ declare class KV<T = any> {
      * Sets a value to a key.
      * @param key - The name of the key.
      * @param value - The value to store.
-     * @returns A promise returning the KV instance.
+     * @returns The value.
      */
-    set(key: string, value: T): Promise<this>;
+    set(key: string, value: T): T;
     /**
      * Gets data by a key.
      * @param key - The existing key's name.
-     * @returns A promise returning the found key, or null.
+     * @returns The found data, or null.
      */
-    get(key: string): Promise<T | null>;
+    get<U = T>(key: string): U | null;
     /**
      * Gets all data in the store.
-     * @returns A promise returning an array of data.
+     * @returns An array of Entry objects [{ key: string, value: T }].
      */
-    all(): Promise<T[]>;
+    all(): Entry<T>[];
     /**
      * Clears all data in the store.
-     * @returns A promise returning the KV instance.
+     * @returns The KV instance.
      */
-    clear(): Promise<this>;
+    clear(): this;
 }
 declare const _default: KV<any>;
 

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.
@@ -14,25 +18,25 @@ declare class KV<T = any> {
      * Sets a value to a key.
      * @param key - The name of the key.
      * @param value - The value to store.
-     * @returns A promise returning the KV instance.
+     * @returns The value.
      */
-    set(key: string, value: T): Promise<this>;
+    set(key: string, value: T): T;
     /**
      * Gets data by a key.
      * @param key - The existing key's name.
-     * @returns A promise returning the found key, or null.
+     * @returns The found data, or null.
      */
-    get(key: string): Promise<T | null>;
+    get<U = T>(key: string): U | null;
     /**
      * Gets all data in the store.
-     * @returns A promise returning an array of data.
+     * @returns An array of Entry objects [{ key: string, value: T }].
      */
-    all(): Promise<T[]>;
+    all(): Entry<T>[];
     /**
      * Clears all data in the store.
-     * @returns A promise returning the KV instance.
+     * @returns The KV instance.
      */
-    clear(): Promise<this>;
+    clear(): this;
 }
 declare const _default: KV<any>;
 

package/dist/index.js

@@ -1 +1 @@
-"use strict";var u=Object.create;var a=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var p=Object.getPrototypeOf,d=Object.prototype.hasOwnProperty;var f=(r,t)=>{for(var s in t)a(r,s,{get:t[s],enumerable:!0})},h=(r,t,s,i)=>{if(t&&typeof t=="object"||typeof t=="function")for(let e of y(t))!d.call(r,e)&&e!==s&&a(r,e,{get:()=>t[e],enumerable:!(i=m(t,e))||i.enumerable});return r};var n=(r,t,s)=>(s=r!=null?u(p(r)):{},h(t||!r||!r.__esModule?a(s,"default",{value:r,enumerable:!0}):s,r)),g=r=>h(a({},"__esModule",{value:!0}),r);var T={};f(T,{KV:()=>c,default:()=>w});module.exports=g(T);var o=n(require("fs/promises")),l=n(require("path")),c=class{#t;#r;constructor(t="::memory::"){if(this.#t=t,this.#r={},t!="::memory::"){this.#t=l.default.resolve(process.cwd(),this.#t);let s=i=>{this.#r=i};this.#i().then(s).catch(()=>({}))}}async#i(){if(this.#t==="::memory::")return{};try{let t=await o.default.readFile(this.#t,"utf8");return JSON.parse(t)||{}}catch{return{}}}async#s(){this.#t!=="::memory::"&&await o.default.writeFile(this.#t,JSON.stringify(this.#r),"utf8")}async set(t,s){try{return this.#r[t]=s,await this.#s(),this}catch(i){throw i}}async get(t){return this.#r[t]??null}async all(){return Object.values(this.#r)}async clear(){try{return this.#r={},await this.#s(),this}catch(t){throw t}}},w=new c;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 e from"node:fs/promises";import a from"node:path";var i=class{#t;#r;constructor(t="::memory::"){if(this.#t=t,this.#r={},t!="::memory::"){this.#t=a.resolve(process.cwd(),this.#t);let r=s=>{this.#r=s};this.#i().then(r).catch(()=>({}))}}async#i(){if(this.#t==="::memory::")return{};try{let t=await e.readFile(this.#t,"utf8");return JSON.parse(t)||{}}catch{return{}}}async#s(){this.#t!=="::memory::"&&await e.writeFile(this.#t,JSON.stringify(this.#r),"utf8")}async set(t,r){try{return this.#r[t]=r,await this.#s(),this}catch(s){throw s}}async get(t){return this.#r[t]??null}async all(){return Object.values(this.#r)}async clear(){try{return this.#r={},await this.#s(),this}catch(t){throw t}}},u=new i;export{i 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,11 +1,14 @@
 {
   "name": "fastkv",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "publishConfig": {
     "access": "public"
   },
   "description": "A key-value store, helpful for caches in apps.",
   "main": "dist/index.js",
+  "repository": {
+    "url": "https://github.com/m1-dev/fastkv"
+  },
   "keywords": [
     "kv",
     "database",
@@ -20,6 +23,7 @@
   },
   "scripts": {
     "build": "tsup",
-    "lint": "tsc --noEmit true"
+    "lint": "tsc --noEmit true",
+    "prepublish": "pnpm run build"
   }
 }