README_v2.md

Node Disk Storage (NDS)

node-disk-storage a simple fast and secure local storage for nodejs, you can store any data using key and value.

• Node Disk Storage (NDS)
  • Installation
  • API Reference
  • Example Usage
  • Testing
  • Bugs
  • Contributing
  • License

Installation

$ npm install node-disk-storage -S or yarn add node-disk-storage -S

API Reference

• Node Disk Storage Options Property

  • minSize limit data size, before saving into disk, default value to 1MB
  • maxSize limit data size, before saving into disk, default value to 25MB
  • compress compress data using gzip, before saving into disk, default value to false

• set(key: string, value: string): boolean | undefined

  set data using key and value, into disk

• get(key: string): any | undefined

  get specific data using key, after saving data into disk

• remove(key: string): boolean | undefined

  remove specific data already exist using key, after saving data into disk

• clear(): boolean | undefined

  clear all keys exist, after saving data into disk

• keys(): boolean | undefined

  get all keys exist, after saving data into disk

Example Usage

• Example Usage Using CommonJs With JavaScript

   const { NodeDiskStorage } = require('node-disk-storage')
  
   const nds = new NodeDiskStorage()
  
   nds.set("name", "joh doe")
   nds.get("name")
   nds.keys()
   nds.remove("name")
   nds.clear()

• Example Usage Using CommonJs With JavaScript And Options

   const { NodeDiskStorage } = require('node-disk-storage')
  
   const nds = new NodeDiskStorage({ minSize: 5, maxSize: 30, compress: true })
  
   nds.set("name", "joh doe")
   nds.get("name")
   nds.keys()
   nds.remove("name")
   nds.clear()

• Example Usage Using ESM With JavaScript

   import { NodeDiskStorage } from 'node-disk-storage'
  
   const nds = new NodeDiskStorage()
  
   nds.set("name", "joh doe")
   nds.get("name")
   nds.keys()
   nds.remove("name")
   nds.clear()

• Example Usage Using ESM With JavaScript And Options

   import { NodeDiskStorage } from 'node-disk-storage'
  
   const nds = new NodeDiskStorage({ minSize: 5, maxSize: 30, compress: true })
  
   nds.set("name", "joh doe")
   nds.get("name")
   nds.keys()
   nds.remove("name")
   nds.clear()

Testing

• Testing Via Local

  npm test or make test

• Testing Via Local And Build

  make build

• Testing Via Docker

  docker build -t node-disk-storage or make dkb tag=node-disk-storage

Bugs

For information on bugs related to package libraries, please visit here

Contributing

Want to make node-disk-storage more perfect ? Let's contribute and follow the contribution guide.

License

• MIT License

BACK TO TOP