fastkv 0.0.0 → 0.1.0

package/README.md

@@ -0,0 +1,46 @@
+<div align="center">
+  <img src="https://jvk6hm88bttdy90i.public.blob.vercel-storage.com/fastkv.png" width="400" style="border-radius: 25px;" />
+</div>
+
+# FastKV
+
+FastKV is a key-value store which offers the following features:
+
+- Persistent storage in JSON files 📁
+- Caching with in-memory storage 🕒
+
+## Installation
+
+Get FastKV via npm using your favourite package manager:
+
+```sh
+npm install fastkv
+# or
+yarn add fastkv
+# or
+pnpm add fastkv
+```
+
+## Example
+
+```js
+import { KV } from 'fastkv';
+
+// For TypeScript users, the KV supports generics:
+// const example = new KV<string>();
+
+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>
+
+// Retreive data by a key
+await kv.get('userSettings'); // => Promise resolving to { theme: 'dark' }
+
+// Retreive all data
+await kv.all(); // => Promise resolving an array: [{ key: 'userSettings', value: { theme: 'dark' } }]
+
+// Clear the store
+await kv.clear(); // => Promise<KV>
+```

package/dist/index.d.mts

@@ -0,0 +1,39 @@
+/**
+ * Represents a key-value store.
+ * Initializing with `::memory::` uses in-memory storage.
+ */
+declare class KV<T = any> {
+    #private;
+    /**
+     * Creates a new instance of the class.
+     * @param location - Where the data will be stored.
+     * Can be `::memory::` or a file location.
+     */
+    constructor(location?: string);
+    /**
+     * 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.
+     */
+    set(key: string, value: T): Promise<this>;
+    /**
+     * Gets data by a key.
+     * @param key - The existing key's name.
+     * @returns A promise returning the found key, or null.
+     */
+    get(key: string): Promise<T | null>;
+    /**
+     * Gets all data in the store.
+     * @returns A promise returning an array of data.
+     */
+    all(): Promise<T[]>;
+    /**
+     * Clears all data in the store.
+     * @returns A promise returning the KV instance.
+     */
+    clear(): Promise<this>;
+}
+declare const _default: KV<any>;
+
+export { KV, _default as default };

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents a key-value store.
+ * Initializing with `::memory::` uses in-memory storage.
+ */
+declare class KV<T = any> {
+    #private;
+    /**
+     * Creates a new instance of the class.
+     * @param location - Where the data will be stored.
+     * Can be `::memory::` or a file location.
+     */
+    constructor(location?: string);
+    /**
+     * 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.
+     */
+    set(key: string, value: T): Promise<this>;
+    /**
+     * Gets data by a key.
+     * @param key - The existing key's name.
+     * @returns A promise returning the found key, or null.
+     */
+    get(key: string): Promise<T | null>;
+    /**
+     * Gets all data in the store.
+     * @returns A promise returning an array of data.
+     */
+    all(): Promise<T[]>;
+    /**
+     * Clears all data in the store.
+     * @returns A promise returning the KV instance.
+     */
+    clear(): Promise<this>;
+}
+declare const _default: KV<any>;
+
+export { KV, _default as default };

package/dist/index.js

@@ -0,0 +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});

package/dist/index.mjs

@@ -0,0 +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};

package/package.json

@@ -1,4 +1,25 @@
 {
   "name": "fastkv",
-  "version": "0.0.0"
-}
+  "version": "0.1.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "A key-value store, helpful for caches in apps.",
+  "main": "dist/index.js",
+  "keywords": [
+    "kv",
+    "database",
+    "json"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.10.5",
+    "@underctrl/tsconfig": "^0.0.1",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "tsc --noEmit true"
+  }
+}