Generates REST middlewares for Sequelize models.
let koa = require('koa');
let Rest = require('koa-sequelize-rest');
let app = koa();
let Model = require('./model');
let ModelRest = new Rest(Model);
app.use(ModelRest.readAll());
Returns
{
"model": [
{ "value": "A" },
{ "value": "B" },
{ "value": "C" }
]
}
koa-sequelize-rest is especially handy when used alongside koa-router :
let router = koaRouter();
router.get('/', ModelRest.readAll());
router.post('/', ModelRest.create());
router.get('/:uuid', ModelRest.readOne());
router.put('/:uuid', ModelRest.update());
router.delete('/:uuid', ModelRest.delete());
app.use(router.routes());
app.use(router.allowedMethods());
Instanciate a new koa-sequelize-rest helper instance.
- (param)
model
, a Sequelize model - (returns)
rest
, a Rest instance tied tomodel
Loads a model
instance in Koa's context state
.
- (param)
includes
- (returns) a generator
Fetches a model
instance and returns it in the response.
- (returns) a generator
Fetches a bunch of model
instances and returns them in the response.
- (param)
options
, a javascript object passed on to Sequelize'sinstance.findAll
- (returns) a generator
Creates and saves a new instance of model
, then returns the newly created instance in the response.
- (returns) a generator
Updates an instance of model
, then returns the updated instance in the response.
- (param)
options
, a javascript object passed on to Sequelize'sinstance.update
- (returns) a generator
Deletes an instance of model
.
- (returns) a generator
MIT