0.0.58 • Published 6 years ago
local2api-sync v0.0.58
Local2Api-Sync
local2api-sync is an API for storing data in Browser (localStorage and sessionStorage) and data synchronization with the Rest API, based on the project: https://instapp.github.io/storagedb.
Features
- Mongo-Sync API
- Lightweight, only 3KB (minified and gzipped)
- No dependencies
- Easy configuration
- Well-supported query selectors (
$gt
,$in
, ...) and options (skip
,limit
,sort
) - Automatically cache in memory
Getting started
Install
npm install --save local2api-sync
Import storagedb to your project (ES6)
import StorageDB from 'local2api-sync'
Or add the script to your main HTML file
<script src="./lib/local2api-sync.min.js"></script>
Collection Supported methods
- insert
(docs)
- remove
(query)
- update
(query, values, options)
- find
(query, options)
- findOne
(query, options)
- drop
()
Usage
Instantiate
const db = new StorageDB({
storage: window.localStorage, // storage object, default is window.localStorage. If you want to store data in memory only, you can set it null
database: 'testdb', // database name, default is 'db'
primaryKey: 'id', // primary key of collection, default is '_id'
revisionKey: 'rev' // revision key of data, default is '__v'
})
// create collection (table) instance
const Users = db.get('users')
insert
Users.insert({
id: 100,
name: 'Elon',
age: 12
})
Users.insert([{
id: 101,
name: 'Larry',
age: 21
}, {
id: 102,
name: 'Sergey',
age: 21
}])
find
Users.find([100, 102])
Users.find({
name: /y$/,
age: {
$gte: 20
}
}, {
skip: 0,
limit: 20,
sort: {
age: 1
}
})
findOne
Users.findOne(102)
Users.findOne({
age: {
$ne: 21
}
})
update
Users.update(100, {
age: 47,
company: 'The Avengers'
})
Users.update({
age: 21
}, {
age: 22
}, {
multi: true
})
remove
Users.remove(101)
Users.remove({
age: 21
})
drop
Users.drop()
License
0.0.58
6 years ago
0.0.57
6 years ago
0.0.56
6 years ago
0.0.55
6 years ago
0.0.54
6 years ago
0.0.53
6 years ago
0.0.52
6 years ago
0.0.51
6 years ago
0.0.50
6 years ago
0.0.49
6 years ago
0.0.48
6 years ago
0.0.47
6 years ago
0.0.46
6 years ago
0.0.45
6 years ago
0.0.44
6 years ago
0.0.43
6 years ago
0.0.42
6 years ago
0.0.41
6 years ago
0.0.40
6 years ago
0.0.39
6 years ago
0.0.38
6 years ago
0.0.37
6 years ago
0.0.36
6 years ago
0.0.35
6 years ago
0.0.34
6 years ago
0.0.33
6 years ago
0.0.32
6 years ago
0.0.31
6 years ago
0.0.30
6 years ago
0.0.29
6 years ago
0.0.28
6 years ago
0.0.27
6 years ago
0.0.26
6 years ago
0.0.25
6 years ago
0.0.24
6 years ago
0.0.23
6 years ago
0.0.22
6 years ago
0.0.21
6 years ago
0.0.2
6 years ago
0.0.1
6 years ago