Giter Site home page Giter Site logo

fastkv's Introduction

FastKV

FastKV is a key-value store which offers the following features:

  • Supports temporary in-memory storage ๐Ÿ•’
  • Supports persistent storage with JSON files ๐Ÿ“
  • Lightweight with no dependencies โšก

Installation

Get FastKV via npm using your favourite package manager:

npm install fastkv
# or
yarn add fastkv
# or
pnpm add fastkv
# or
bun add fastkv

Example

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
kv.set('userSettings', { theme: 'dark' });

// Retreive data by a key
kv.get('userSettings'); // -> { theme: 'dark' }

// Retreive all data
kv.all(); // -> [{ key: 'userSettings', value: { theme: 'dark' } }]

// Clear the store
kv.clear();

fastkv's People

Contributors

notm1dev avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.