https://github.com/greguz/mutent
An agnostic solution to work with any Datastore
https://github.com/greguz/mutent
collection database datastore entity javascript
Last synced: about 1 year ago
JSON representation
An agnostic solution to work with any Datastore
- Host: GitHub
- URL: https://github.com/greguz/mutent
- Owner: greguz
- License: mit
- Created: 2019-11-29T12:04:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-15T06:55:38.000Z (over 2 years ago)
- Last Synced: 2024-03-15T08:48:57.408Z (about 2 years ago)
- Topics: collection, database, datastore, entity, javascript
- Language: JavaScript
- Homepage: https://greguz.github.io/mutent/
- Size: 958 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mutent
[](https://www.npmjs.com/package/mutent)
[](https://standardjs.com)
[](https://github.com/greguz/mutent/actions)
[](https://coveralls.io/github/greguz/mutent?branch=master)
Mutent is an agnostic solution to work with any Datastore.
## Features
- **Zero dependencies**: small footprint.
- **Pure ES2018 code**: any environment that can run ES2018 code can directly include this module. Downgrading with tools like [Babel](https://babeljs.io/) is still possible.
- **Extensible**: a powerful hooks system in place.
- **Agnostic**: can be configured to work with any Datastore through Adapters.
- **TypeScript**: type declarations are included.
- **ESM**: support native ESM.
- **CommonJS**: support old Node.js runtimes (`require`).
- **Well tested**: code coverage above 95%.
## Installation
```
npm install --save mutent
```
## Documentation
Start from the [Quickstart](https://greguz.github.io/mutent/) section.
## Example
```javascript
import { Store } from 'mutent'
// Define simple array adapter (persist entities inside the array)
class ArrayAdapter {
constructor(array = []) {
this.array = array
}
find(predicate) {
return this.array.find(predicate)
}
filter(predicate) {
return this.array.filter(predicate)
}
create(data) {
this.array.push(data)
}
update(oldData, newData) {
this.array.splice(
this.array.findIndex(entity => entity === oldData),
1,
newData
)
}
delete(data) {
this.array.splice(
this.array.findIndex(entity => entity === data),
1
)
}
}
async function foo() {
// Our "datastore"
const database = []
// Create mutent store
const store = new Store({
adapter: new ArrayAdapter(database)
})
// Create a new entity
const dexter = await store
.create({
name: 'Dexter',
protagonist: true
})
.unwrap()
console.log(dexter) // Dexter
console.log(database) // Dexter
// Create multiple entities
const family = await store
.create([
{
name: 'Dee Dee',
protagonist: true
},
{ name: 'Mom' },
{ name: 'Dad' }
])
.unwrap()
console.log(family) // Dee Dee, Mom, Dad
console.log(database) // Dexter, Dee Dee, Mom, Dad
// Find one entity
const firstProtagonist = await store
.find(entity => entity.protagonist) // Declare adapter query
.unwrap()
console.log(firstProtagonist) // Dexter
// Filter entities
const allProtagonists = await store
.filter(entity => entity.protagonist) // Declare adapter query
.unwrap()
console.log(allProtagonists) // Dexter, Dee Dee
// Update
const newDexter = await store
.find(entity => entity.name === 'Dexter') // Declare adapter query
.update(entity => ({ ...entity, surname: 'McPherson' })) // Declare entity mutation
.unwrap()
console.log(newDexter) // Dexter McPherson
console.log(database) // Dexter McPherson, Dee Dee, Mom, Dad
// Assign (update)
const newDeeDee = await store
.find(entity => entity.name === 'Dee Dee') // Declare adapter query
.assign({ surname: 'McPherson' }) // Update with Object.assign()
.unwrap()
console.log(newDeeDee) // Dee Dee McPherson
console.log(database) // Dexter McPherson, Dee Dee McPherson, Mom, Dad
// Delete entities
const deletedParents = await store
.filter(entity => !entity.protagonist) // Declare adapter query
.delete() // Tell mutent we want to delete matching entities
.unwrap()
console.log(deletedParents) // Mom, Dad
console.log(database) // Dexter, Dee Dee
}
foo().catch(err => console.error(err))
```