Unique validation for Objection.js

!node

This plugin adds a unique validation for Objection.js models.

NOTE: Unique validation at update only works with $query methods.

Installation

$3

``sh
npm i objection-unique --save
`

$3

`sh
yarn add objection-unique
`

Usage

$3

`js
// Import objection model.
const Model = require('objection').Model;

// Import the plugin.
const unique = require('objection-unique')({
fields: ['email', 'username', ['phone_prefix','phone_number']],
identifiers: ['id']
});

// Mixin the plugin.
class User extends unique(Model) {
static get tableName() {
return 'User';
}
}
`

$3

`js
/**
* Insert.
*/

// Insert one user.
await User.query().insert({ email: 'foo', username: 'bar' });

try {
// Try to insert another user with the same data.
await User.query().insert({ email: 'foo', username: 'bar' });
} catch (e) {
// Exception with the invalid unique fields
//
// {
// email: [{
// keyword: 'unique',
// message: 'email already in use.'
// }],
// username: [{
// keyword: 'unique',
// message: 'username already in use.'
// }
// }
}
`

$3

`js
/**
* Update/Patch.
*/

// Insert one user.
await User.query().insert({ email: 'foo', username: 'bar' });

// Insert the user that we want to update.
const user = await User.query().insertAndFetch({ email: 'biz', username: 'buz' });

try {
user.$query().update({ email: 'foo', username: 'buz' });
// user.$query().patch({ email: 'foo' });
} catch (e) {
// Exception with the invalid unique fields
//
// {
// email: [{
// keyword: 'unique',
// message: 'email already in use.'
// }]
// }
}
`

Options

fields: The unique fields. Compound fields can be specified as an array

identifiers: The fields that identifies the model. (Default: ['id'])

These options can be provided when instantiating the plugin:

`js
const unique = require('objection-unique')({
fields: ['email', 'username', ['phone_prefix', 'phone_number']],
identifiers: ['id']
});
`

Tests

Run the tests from the root directory:

`sh
npm test
`

Contributing & Development

$3

Found a bug or want to suggest something? Take a look first on the current and closed issues. If it is something new, please submit an issue.

$3

It will be awesome if you can help us evolve objection-unique. Want to help?

1. Fork it.
2. npm install.
3. Hack away.
4. Run the tests: npm test`.
5. Create a Pull Request.