The flexible Node.js ORM.
Simplifies tasks such as creating and validating schemas for models as well as storing and getting entries from the database.
- Installation
- Quick Start
- Create instance
- Get instance
- Filter instances
- Update instance
- Schemas
- Errors
- Contributing
npm install stormer
1. Create a new store
var store = new Store();2. Define a new model and its schema
var store = new Store();
var userSchema = {
id: {
type: 'String',
primaryKey: true
},
firstName: 'String',
age: {
type: 'Number',
required: true
}
};
store.define('users', userSchema);Supported types:
StringNumberObjectArrayBooleanDate(v0.9.0 and later)
2.1. Set an alias for a model name
const assert = require('assert');
const store = new Store();
let model = {
id: {
type: 'String',
primaryKey: true
}
};
store.define('production.users', model);
store.alias('users', 'production.users');
assert(store.getModel('users') === store.getModel('production.users'));3. Implement the required store methods
store._get = function(model, pk) {
// Use pk to fetch single entry from your db of choice
// Returns a Promise
// Resolve the promise with the entry as the value if found
// Resolve the promise with empty value if not found or reject with a NotFoundError
};
store._filter = function(model, query) {
// Use query to fetch multiple entries matching the query from your db of choice
// Returns a Promise
// Resolve the promise with an array of entries or an empty array if none is mathcing
};
store._set = function(model, obj) {
// Use obj to create or update the entry in the db of choice
// Returns a Promise
// Resolve the promise with the set obj
};store.create('users', {
id: '1234',
firstName: 'George',
age: 12
}).then(function(newInstance) {
// Do something with the instance
}).catch(ValidationError, function(err) {
// Handle a validation error
}).catch(function(err) {
// Handle error
}); store.get('users', '1234').then(function(instance) {
// Do something with the instance
}).catch(NotFoundError, function(err) {
//Handle NotFoundError
}).catch(function(err) {
// Handle generic error
}); store.filter('users', {
name: 'George'
}).then(function(instances) {
// Do something with the instances
}).catch(function(err) {
// Handle generic error
}); store.get('users', {
id: '1234',
firstName: "George",
age: 15
}).then(function(updatedInstance) {
// Do something with the instance
}).catch(function(err) {
// Handle error
});Any field can be designated as the primary key. Only one field can be designated as the primary key.
// Defines the 'id' field as the primary key
var schema = {
id: {
type: 'String',
primaryKey: true
}
};// Defines an 'address'' property with nested schema
var schema = {
name: 'String',
address: {
type: 'Object',
streetName: 'String',
streetNumber: 'Number',
poBox: 'Number'
}
};// Defines a 'friends' property with Array type
var schema = {
firstName: 'String',
friends: {
type: 'Array',
of: 'String'
}
};You can define a validate(value) function on each property. The value argument passed can be used to check the validity of the value and return either a truthy or falsy value. If a falsy value is returned then a CustomValidationError is thrown.
// Defines a 'age' property with custom validation
var schema = {
age: {
type: 'Number',
validate: function(value) {
return value > 0;
}
}
};You can import the errors using require('stormer').errors.<errorName>
-
TypeValidationError: This error indicates that an operation failed because a schema property didn't conform with the designated type -
CustomValidationError: This error indicates that an operation failed because a schema property failed a custom validation -
NotFoundError: This error indicates that the object was not found in the store -
AlreadyExistsError: This error indicates that the object already exists in the store
This project is work in progress and we'd love more people contributing to it.
- Fork the repo
- Apply your changes
- Write tests
- Submit your pull request
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent