Custom VError

Simple class extending VError for easy custom error creation.

Usage

Here is the basic usage. For more use cases, see the tests.

1. Define your error

UserNotAllowedError.js

1'use strict';
2
3const CustomVError = require('custom-verror');
4
5// Replace UserNotAllowedError with your custom error name
6module.exports = class UserNotAllowedError extends CustomVError {
7	constructor(...args) {
8		super(...args);
9		// Provide a default message
10		this.message = this.message || 'User is not allowed to perform this action';
11	}
12};

2. Throw your error

1const UserNotAllowedError = require('./UserNotAllowedError');
2
3function performAction() {
4	if (!isAllowed) {
5		throw new UserNotAllowedError({
6			// You can provide some error metadata. This will be appended to the message
7			info: {
8				user_id: user._id
9			}
10		})
11	}
12}

3. Catch your error

1try {
2	performAction();
3} catch (ex) {
4	if (ex instanceof UserNotAllowedError) {
5		numberOfTimesUsersTriedToDoSomethingTheyWerentSupposedTo++;
6		// This will log the default message and the metadata in following format:
7		// "User is not allowed to perform this action user_id=FOO"
8		console.log(ex);
9	}
10}