Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/restuwahyu13/node-disk-storage
Fast and Secure local storage persistent data for Node JS
https://github.com/restuwahyu13/node-disk-storage
cache-storage caching data-store disk-storage keyvalue keyvaluestore local local-storage localstorage module node-module nodejs npm-package persist persistance persistent-data persistent-storage session session-storage
Last synced: about 1 month ago
JSON representation
Fast and Secure local storage persistent data for Node JS
- Host: GitHub
- URL: https://github.com/restuwahyu13/node-disk-storage
- Owner: restuwahyu13
- License: mit
- Created: 2021-08-13T16:36:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T12:58:56.000Z (almost 2 years ago)
- Last Synced: 2024-11-08T06:40:30.855Z (about 1 month ago)
- Topics: cache-storage, caching, data-store, disk-storage, keyvalue, keyvaluestore, local, local-storage, localstorage, module, node-module, nodejs, npm-package, persist, persistance, persistent-data, persistent-storage, session, session-storage
- Language: TypeScript
- Homepage:
- Size: 576 KB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-made-by-indonesian - Node Disk Storage (NDS) - `Fast and Secure local storage persistent data for Node JS` *by [Restu Wahyu Saputra](https://github.com/restuwahyu13)* (N)
- made-in-indonesia - Node Disk Storage (NDS) - `Fast and Secure local storage persistent data for Node JS` *by [Restu Wahyu Saputra](https://github.com/restuwahyu13)* (N)
README
# Node Disk Storage (NDS)
[](https://scrutinizer-ci.com/g/restuwahyu13/node-disk-storage/build-status/main)
[](https://coveralls.io/github/restuwahyu13/node-disk-storage?branch=main)
[](https://www.codefactor.io/repository/github/restuwahyu13/node-disk-storage)
[](https://codebeat.co/projects/github-com-restuwahyu13-node-disk-storage-main)
[](https://www.codacy.com/gh/restuwahyu13/node-disk-storage/dashboard?utm_source=github.com&utm_medium=referral&utm_content=restuwahyu13/node-disk-storage&utm_campaign=Badge_Grade)
[](https://github.com/restuwahyu13/node-disk-storage/blob/main/CONTRIBUTING.md)
**node-disk-storage** a simple fast and secure `local storage` for `nodejs`, you can store any data using key and value, and then your data will be **encrypt**
to be like this `�+�)data|ZGF0YXxqb2huK2RvZV5eXiQwfDFd^^^$0|1`.
- [Node Disk Storage (NDS)](#node-disk-storage-nds)
- [Installation](#installation)
- [API Reference](#api-reference)
- [Example Usage](#example-usage)
- [Testing](#testing)
- [Bugs](#bugs)
- [Contributing](#contributing)
- [License](#license)
## Installation
```bash
$ 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**
- #### set(key: string, value: any): Promise
set data using key and value, into disk
- #### get(key: string): Promise
get specific data using key, after saving data into disk
- #### key(key: string): Promise
get specific key, after saving data into disk
- #### remove(key: string): Promise
remove specific data already exist using key, after saving data into disk
- #### clear(): Promise
clear all keys exist, after saving data into disk
- #### keys(): Promise
get all keys exist, after saving data into disk
## Example Usage
- ##### Example Usage Using CommonJs With JavaScript
```javascript
const { NodeDiskStorage } = require('node-disk-storage')
const nds = new NodeDiskStorage()
;(async () => {
await nds.set('user', {
id: 1,
name: 'Leanne Graham',
username: 'Bret',
email: '[email protected]',
address: {
street: 'Kulas Light',
suite: 'Apt. 556',
city: 'Gwenborough',
zipcode: '92998-3874',
geo: { lat: '-37.3159', lng: '81.1496' }
},
phone: '1-770-736-8031 x56442',
website: 'hildegard.org',
company: {
name: 'Romaguera-Crona',
catchPhrase: 'Multi-layered client-server neural-net',
bs: 'harness real-time e-markets'
}
})
await nds.get('user')
await nds.key('user')
await nds.keys()
await nds.remove('user')
await nds.clear()
})()
```
- ##### Example Usage Using CommonJs With JavaScript And Options
```javascript
const { NodeDiskStorage } = require('node-disk-storage')
const nds = new NodeDiskStorage({ minSize: 5, maxSize: 30 })
;(async () => {
await nds.set("user", {
id: 1,
name: 'Leanne Graham',
username: 'Bret',
email: '[email protected]',
address: {
street: 'Kulas Light',
suite: 'Apt. 556',
city: 'Gwenborough',
zipcode: '92998-3874',
geo: { lat: '-37.3159', lng: '81.1496' }
},
phone: '1-770-736-8031 x56442',
website: 'hildegard.org',
company: {
name: 'Romaguera-Crona',
catchPhrase: 'Multi-layered client-server neural-net',
bs: 'harness real-time e-markets'
}
})
await nds.get("user")
await nds.key('user')
await nds.keys()
await nds.remove("user")
await nds.clear()
```
- ##### Example Usage Using ESM With JavaScript
```javascript
import { NodeDiskStorage } from 'node-disk-storage'
const nds = new NodeDiskStorage()
;(async () => {
await nds.set("user", {
id: 1,
name: 'Leanne Graham',
username: 'Bret',
email: '[email protected]',
address: {
street: 'Kulas Light',
suite: 'Apt. 556',
city: 'Gwenborough',
zipcode: '92998-3874',
geo: { lat: '-37.3159', lng: '81.1496' }
},
phone: '1-770-736-8031 x56442',
website: 'hildegard.org',
company: {
name: 'Romaguera-Crona',
catchPhrase: 'Multi-layered client-server neural-net',
bs: 'harness real-time e-markets'
}
})
await nds.get("user")
await nds.key('user')
await nds.keys()
await nds.remove("user")
await nds.clear()
```
- ##### Example Usage Using ESM With JavaScript And Options
```javascript
import { NodeDiskStorage } from 'node-disk-storage'
const nds = new NodeDiskStorage({ minSize: 5, maxSize: 30 })
;(async () => {
await nds.set("user", {
id: 1,
name: 'Leanne Graham',
username: 'Bret',
email: '[email protected]',
address: {
street: 'Kulas Light',
suite: 'Apt. 556',
city: 'Gwenborough',
zipcode: '92998-3874',
geo: { lat: '-37.3159', lng: '81.1496' }
},
phone: '1-770-736-8031 x56442',
website: 'hildegard.org',
company: {
name: 'Romaguera-Crona',
catchPhrase: 'Multi-layered client-server neural-net',
bs: 'harness real-time e-markets'
}
})
await nds.get("user")
await nds.key('user')
await nds.keys()
await nds.remove("user")
await nds.clear()
```
## Testing
- Testing Via Local
```sh
npm test or make test
```
- Testing Via Local And Build
```sh
make build
```
- Testing Via Docker
```sh
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](https://github.com/restuwahyu13/node-disk-storage/issues)
## Contributing
Want to make **node-disk-storage** more perfect ? Let's contribute and follow the
[contribution guide.](https://github.com/restuwahyu13/node-disk-storage/blob/main/CONTRIBUTING.md)
## License
- [MIT License](https://github.com/restuwahyu13/node-disk-storage/blob/main/LICENSE.md)