added necessary npm packages

This commit is contained in:
Aqeeb Imtiaz Harun
2018-08-09 11:15:09 +08:00
parent 93ee4ecb68
commit fc1b011160
2787 changed files with 243227 additions and 1 deletions
+144
View File
@@ -0,0 +1,144 @@
# Examples
## CLI
```js
// cli.js
const low = require('lowdb')
const db = low('db.json')
db.defaults({ posts: [] })
.write()
const result = db.get('posts')
.push({ name: process.argv[2] })
.write()
console.log(result)
```
```sh
$ node cli.js hello
# [ { title: 'hello' } ]
```
## Browser
```js
import low from 'lowdb'
const db = low('db')
db.defaults({ posts: [] })
.write()
// Data is automatically saved to localStorage
db.get('posts')
.push({ title: 'lowdb' })
.write()
```
## Server
Please __note__ that if you're developing a local server and don't expect to get concurrent requests, it's often easier to use `file-sync` storage, which is the default.
But if you need to avoid blocking requests, you can do so by using `file-async` storage.
```js
const express = require('express')
const low = require('lowdb')
const fileAsync = require('lowdb/lib/storages/file-async')
// Create server
const app = express()
// Start database using file-async storage
const db = low('db.json', {
storage: fileAsync
})
// Routes
// GET /posts/:id
app.get('/posts/:id', (req, res) => {
const post = db.get('posts')
.find({ id: req.params.id })
.value()
res.send(post)
})
// POST /posts
app.post('/posts', (req, res) => {
db.get('posts')
.push(req.body)
.last()
.assign({ id: Date.now() })
.write()
.then(post => res.send(post))
})
// Init
db.defaults({ posts: [] })
.write()
.then(() => {
app.listen(3000, () => console.log('Server is listening')
})
```
Using ES7 `async/await` and [Babel](https://babeljs.io/), you can simplify the previous `POST` example above like this:
```js
app.post('/posts', async (req, res) => {
const post = await db.get('posts')
.push(req.body)
.last()
.assign({ id: Date.now() })
.write()
res.send(post)
})
```
## In-memory
In this mode, no storage is used. Everything is done in memory.
You can still persist data but you'll have to do it yourself. Here's an example:
```js
const fs = require('fs')
const db = low()
db.defaults({ posts: [] })
.write()
db.get('posts')
.push({ title: 'lowdb' })
.write()
// Manual writing
fs.writeFileSync('db.json', JSON.stringify(db.getState()))
```
In this case, it's recommended to create a custom storage.
## FP
This particular mode lets you use [lodash/fp](https://github.com/lodash/lodash/wiki/FP-Guide), [Ramda](https://github.com/ramda/ramda) or simple JavaScript functions with lowdb. If you're using Lowdb with a bundler like Webpack or Browserify it can help reducing the size of your bundle.js.
```js
import low from 'lowdb/lib/fp'
import concat from 'lodash/fp/concat'
const db = low()
// Get or set posts
const posts = db('posts', [])
posts.write(
concat({ title: 'lowdb is awesome' })
)
const post = posts(
find({ id: 1 })
)
```