Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spiffgreen/browsedb
BrowseDB is a javascript clientside library for managing localStorage data in mongoose style.
https://github.com/spiffgreen/browsedb
browsedb browser clientside data databases db frontend javascript localstorage
Last synced: 22 days ago
JSON representation
BrowseDB is a javascript clientside library for managing localStorage data in mongoose style.
- Host: GitHub
- URL: https://github.com/spiffgreen/browsedb
- Owner: SpiffGreen
- License: gpl-3.0
- Created: 2021-06-01T00:29:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-06-09T01:46:53.000Z (over 3 years ago)
- Last Synced: 2024-10-19T07:28:15.248Z (30 days ago)
- Topics: browsedb, browser, clientside, data, databases, db, frontend, javascript, localstorage
- Language: JavaScript
- Homepage: https://spiffgreen.github.io/browsedb-js/
- Size: 74.2 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
BrowseDB 🛢️
BrowseDB is a JavaScript clientside library for managing localStorage data in mongoose style. BrowseDB provides its users, methods for managing localStorage data efficiently. It can be used for simple CRUD operations. BrowseDB's data is stored in string format but all data operations are done in JSON format.
  
   
[Visit Site For more Docs](https://spiffgreen.github.io/browsedb-js/)
## 📕 Terminologies
`Collections` - All BrowseDB instances are called collections, as they are just collections(arrays) of objects(documents).
`Documents` - As you might have guessed, are simply objects.
`Schema` - A schema is simply an object that describes the expected structure or blueprint of documents of a particular collection. This could be used for some sort of type checking. It is optional.
## ⚙️Usage and Settings
First, to use browsedb. Include/import browsedb, then create an instance of browsedb. Example
```javascript
import BrowseDB from "browsedb";
const schema = {
text: {
type: String,
required: true
},
done: Boolean,
date: {
type: Number,
required: true,
default: Date.now
}
};
const todos = new BrowseDB("todos", schema);
```
## ▶️Methods
* `create` - Used for creating documents. It accepts an object containing required data for object creation and returns a copy of the new document inserted into localStorage with its ID. BrowseDB generates a unique ID for the newly inserted document.
```javascript
todos.create({ text: "Learn BrowseDB", done: false });
```
* `find` - For finding documents. It accepts two optional parameters: __query__ and __key__. __query__ is used in similar fashion to 'WHERE' in SQL like databases, While __key__ is used for filtering results. Example
```javascript
todos.find(); // Returns all documents
todos.find({}) // Returns all documents
todos.find({ done: true }); // Returns all documents where done equal true
todos.find({ done: false }, {done: 0, id: 0}); // Returns documents where done equal false but doesn't show done and id's of each document.
```
* `findById` - For finding documents based on id. It accepts one parameter: __id__. __id__(string) represents id of a document. It returns a document with the passed id.
```javascript
todos.findById("zUVxUed827"); // Returns Document with id 'zUVxUed827'
```
* `update` - For updating data in document(s). It accepts two parameters: __query__ and __data__. Here, query is used as 'WHERE' would be used Relational databases, while __data__ represents the new data to be put into selected documents. The below example will find all documents where done = false, and update the text field.
```javascript
todos.update({done: false}, {text: "Todo is not yet done"});
```
* `updateById` - For updating data in a document based on id. It finds a document by id, updates its content and returns the updated content. It accepts two parameters: __id__ and __data__.
* `updateAll` - For updating all documents data at once. It accepts one parameter: __data__.
* `delete` - Finds and deletes documents. Accepts one parameter: __query__ - Where the delete operation should take place.
* `deleteById` - Finds, deletes and returns a document with id passed to it. Accepts one parameter __id__.
* `deleteAll` - Deletes all documents in a collection.
* `remove` - This function is a bit similar in behaviour to `delete`.
## Installation
### Content Delivery Networks
🚀CDN Link https://unpkg.com/[email protected]/browsedb.min.js
HTML Tag
```html
<script>
```
### 📦Using NPM
```bash
npm install browsedb
```
## Caveats
### Schema
Like mongoose, BrowseDB supports schema. But in BrowseDB uses the builtin types available to javascript for type checking. Hence, `Date` isn't a type as it produces a number.
But there is a work around for this. Instead of:
```javascript
{
detail: {
type: String,
required: true
},
date: {
type: Date,
default: Date.now
}
}
```
One should do:
```javascript
{
detail: {
type: String,
required: true
},
date: {
type: Number,
default: Date.now
}
}
```
## ⛏️Development
* yarn build or npm run build - produces a production version of library under the lib folder
## ⭐️Show your support
Please star this repository if this project helped you!
## 👋 Contributing
Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file to see how to contribute.
## 🌤️Browser compatibility
Browsedb works across all browsers that support localStorage.
You could check for compatibility here:
* https://caniuse.com/#search=localStorage
## 📄License
[GPL-3.0 License](./LICENSE)
Copyright (c) Spiff Jekey-Green