sequelize-values
Version:
Easily get raw data from Sequelize instances
129 lines (87 loc) • 4.42 kB
Markdown
# sequelize-values.js
# Easily get raw data from Sequelize instances
[](https://www.npmjs.com/package/sequelize-values)
[](http://travis-ci.org/overlookmotel/sequelize-values)
[](https://david-dm.org/overlookmotel/sequelize-values)
[](https://david-dm.org/overlookmotel/sequelize-values)
[](https://coveralls.io/r/overlookmotel/sequelize-values)
## What it does
A few utility functions for getting raw data from Sequelize instances. Includes ability to remove duplicate data.
## Current status
Requires Sequelize v2.x.x, v3.x.x or v4.x.x.
Version v1.0.0 onwards supports only Node v4 or higher. Currently, all tests pass on Node v0.10 and v0.12, but these versions of Node will no longer be tested against so this cannot be guaranteed in future releases.
## Usage
### Loading module
To load module:
```js
var Sequelize = require('sequelize-values')();
// NB Sequelize must also be present in `node_modules`
```
or, a more verbose form useful if chaining multiple Sequelize plugins:
```js
var Sequelize = require('sequelize');
require('sequelize-values')(Sequelize);
```
### Methods
#### Instance#getValues()
Like Sequelize's native `Instance#values`, except that it recursively calls `getValues()` on any nested values. So if you get an instance from `Model#find()` with eager-loaded associations, the associated Instances returned are also converted to values.
```js
Task.find( { include: [ User ] } )
.then(function(task) {
return task.getValues();
// returns the attributes of the Task,
// with the attributes of the User also converted to values rather than a DAO.
});
```
#### Sequelize.getValues(input)
Same as `Instance#getValues()` except can be called with an `Instance` or array of `Instance`s.
```js
Task.findAll( { include: [ User ] } )
.then(function(tasks) {
return Sequelize.getValues(tasks);
// returns the array of Tasks, with each Task converted to plain attributes,
// with the attributes of the Users also converted to values rather than DAOs.
});
```
#### Instance#getValuesDedup()
Same as `Instance#getValues()`, except removes redundant duplicated data, e.g. removes `id` fields which are repeated twice.
Useful if you want to e.g. send the values of an Model Instance to the browser without sending unnecessary duplicated data.
Examples:
##### belongsTo association
```js
// .getValues() - UserId is repeated as UserId and user.id
{ name: 'A task', UserId: 1, User: { id: 1, name: 'A user' } }
// .getValuesDedup() - UserId is removed
{ name: 'A task', User: { id: 1, name: 'A user' } }
```
##### hasMany association
```js
// .getValues() - UserId is repeated as id and Tasks[].UserId
{ id: 1, name: 'A user', Tasks: [ { UserId: 1, name: 'A task' } ] }
// .getValuesDedup() - Tasks[].UserId is removed
{ id: 1, name: 'A user', Tasks: [ { name: 'A task' } ] }
```
##### belongsToMany association
```js
// .getValues()
// - UserId is repeated as id and Tasks[].UserTask.UserId
// - TaskId is repeated as Tasks[].id and Tasks[].UserTask.TaskId
{ id: 1, name: 'A user', Tasks: [ { id: 2, name: 'A task', UserTask: { UserId: 1, TaskId: 2 } } ] }
// .getValuesDedup() - Tasks[].UserTask is removed
{ id: 1, name: 'A user', Tasks: [ { id: 2, name: 'A task' } ] }
```
#### Sequelize.getValuesDedup(input)
Same as `Sequelize.getValues(input)`, but with data de-duplication as per `Instance#getValuesDedup()`.
## Tests
Use `npm test` to run the tests. Use `npm run cover` to check coverage.
Requires a database called 'sequelize_test' and a db user 'sequelize_test' with no password.
## Changelog
See [changelog.md](https://github.com/overlookmotel/sequelize-values/blob/master/changelog.md)
## Issues
If you discover a bug, please raise an issue on Github. https://github.com/overlookmotel/sequelize-values/issues
## Contribution
Pull requests are very welcome. Please:
* ensure all tests pass before submitting PR
* add an entry to changelog
* add tests for new features
* document new functionality/API additions in README