Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bonnevoyager/quick-storage
Simple key/value storage module with persistency.
https://github.com/bonnevoyager/quick-storage
browser data fs indexeddb javascript key-value nodejs persistence quick server storage
Last synced: 5 days ago
JSON representation
Simple key/value storage module with persistency.
- Host: GitHub
- URL: https://github.com/bonnevoyager/quick-storage
- Owner: BonneVoyager
- Created: 2018-06-19T06:06:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:33:10.000Z (over 1 year ago)
- Last Synced: 2024-11-01T03:42:37.981Z (14 days ago)
- Topics: browser, data, fs, indexeddb, javascript, key-value, nodejs, persistence, quick, server, storage
- Language: TypeScript
- Homepage:
- Size: 284 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# QuickStorage
Simple key/value storage module with persistency on file system.
This module used to work in the browser with IndexedDB, more info can be found here https://github.com/BonneVoyager/quick-storage/tree/v1.4.0.
## Installation
```
npm install --save quick-storage
```
## Usage
`QuickStorage` expects an argument - a path to store data in the file system (otherwise, it will throw).
```ts
import QuickStorage from 'quick-storage'
const myStorage = new QuickStorage(`${__dirname}/data`)
```
This will create `${__dirname}/data` directory and store data in it. Each data key will be stored in separate file (key `myKey` will be store in file `${__dirname}/data/myKey`). File content is stringified on write, and parsed on read.
## API
```js
myStorage.set('myKey', { foo: 'bar' })
```
```js
myStorage.has('myKey') // true
```
```js
myStorage.get('myKey') // { "foo": "bar" }
```
```js
myStorage.keys() // [ "foo" ]
```
```js
myStorage.delete('myKey')
```
```js
myStorage.isReady // false before onReady callback, and true afterwards
```
```js
myStorage.onReady((fn) => {
console.info('All previous data was read and I am ready for some work!')
})
```
```js
myStorage.onError((err) => {
console.error('My storage error:', err)
})
```
```js
const obj = { foo: "bar" }
myStorage.proxy(obj, {
preventExtensions: true, // whether to invoke Object.preventExtensions(obj)
persistProps: [ 'foo' ] // props which should keep the persistency
})
```
## Few tips
- please keep in mind that this module is intended to be used with small chunks of data (up to dozens of megabytes). All the data is stored in memory with `Map` cache object.
- data is parsed between string and json. That means that this module works only with JSON objects.
- when you create `QuickStorage(__dirname + '/data')`, the script will try to find and read data associated with `__dirname + '/data'` (read FS on the server). After it's read, storage object will call `onReady` function.
- you can use a callback as a second argument for `get` function to force read the data from the FS, instead of `Map` cache object.
## Test
```
npm run test
```
## Changelog
[CHANGELOG.md](https://github.com/BonneVoyager/quick-storage/blob/master/CHANGELOG.md)
## License
[MIT](LICENSE)