Easily get raw data from Sequelize instances
What it does
A few utility functions for getting raw data from Sequelize instances. Includes ability to remove duplicate data.
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.
To load module:
var Sequelize = ;// NB Sequelize must also be present in `node_modules`
or, a more verbose form useful if chaining multiple Sequelize plugins:
var Sequelize = ;Sequelize;
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.
Instance#getValues() except can be called with an
Instance or array of
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.
// .getValues() - UserId is repeated as UserId and user.idname: 'A task' UserId: 1 User: id: 1 name: 'A user'// .getValuesDedup() - UserId is removedname: 'A task' User: id: 1 name: 'A user'
// .getValues() - UserId is repeated as id and Tasks.UserIdid: 1 name: 'A user' Tasks: UserId: 1 name: 'A task'// .getValuesDedup() - Tasks.UserId is removedid: 1 name: 'A user' Tasks: name: 'A task'
// .getValues()// - UserId is repeated as id and Tasks.UserTask.UserId// - TaskId is repeated as Tasks.id and Tasks.UserTask.TaskIdid: 1 name: 'A user' Tasks: id: 2 name: 'A task' UserTask: UserId: 1 TaskId: 2// .getValuesDedup() - Tasks.UserTask is removedid: 1 name: 'A user' Tasks: id: 2 name: 'A task'
Sequelize.getValues(input), but with data de-duplication as per
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.
If you discover a bug, please raise an issue on Github. https://github.com/overlookmotel/sequelize-values/issues
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