@hapi/boom - npm Package Compare versions

Comparing version 10.0.0 to 10.0.1

lib/index.d.ts

@@ -7,3 +7,3 @@ /**
     /**
-     * Creates a new Boom object using the provided message
+     * Creates a new Boom object using the provided message or Error
      */
@@ -162,3 +162,3 @@ constructor(message?: string | Error, options?: Options<Data>);
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -168,3 +168,3 @@ *
 */
-export function badRequest<Data>(message?: string, data?: Data): Boom<Data>;
+export function badRequest<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -175,7 +175,7 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 *
 * @returns A 401 Unauthorized error
 */
-export function unauthorized<Data>(message?: string | null): Boom<Data>;
+export function unauthorized<Data>(messageOrError?: string | Error | null): Boom<Data>;
 
@@ -226,3 +226,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -232,3 +232,3 @@ *
 */
-export function paymentRequired<Data>(message?: string, data?: Data): Boom<Data>;
+export function paymentRequired<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -239,3 +239,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -245,3 +245,3 @@ *
 */
-export function forbidden<Data>(message?: string, data?: Data): Boom<Data>;
+export function forbidden<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -252,3 +252,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -258,3 +258,3 @@ *
 */
-export function notFound<Data>(message?: string, data?: Data): Boom<Data>;
+export function notFound<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -265,3 +265,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -272,3 +272,3 @@ * @param allow - Optional string or array of strings which is used to set the 'Allow' header
 */
-export function methodNotAllowed<Data>(message?: string, data?: Data, allow?: string | string[]): Boom<Data>;
+export function methodNotAllowed<Data>(messageOrError?: string | Error, data?: Data, allow?: string | string[]): Boom<Data>;
 
@@ -279,3 +279,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -285,3 +285,3 @@ *
 */
-export function notAcceptable<Data>(message?: string, data?: Data): Boom<Data>;
+export function notAcceptable<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -292,3 +292,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -298,3 +298,3 @@ *
 */
-export function proxyAuthRequired<Data>(message?: string, data?: Data): Boom<Data>;
+export function proxyAuthRequired<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -305,3 +305,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -311,3 +311,3 @@ *
 */
-export function clientTimeout<Data>(message?: string, data?: Data): Boom<Data>;
+export function clientTimeout<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -318,3 +318,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -324,3 +324,3 @@ *
 */
-export function conflict<Data>(message?: string, data?: Data): Boom<Data>;
+export function conflict<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -331,3 +331,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -337,3 +337,3 @@ *
 */
-export function resourceGone<Data>(message?: string, data?: Data): Boom<Data>;
+export function resourceGone<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -344,3 +344,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -350,3 +350,3 @@ *
 */
-export function lengthRequired<Data>(message?: string, data?: Data): Boom<Data>;
+export function lengthRequired<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -357,3 +357,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -363,3 +363,3 @@ *
 */
-export function preconditionFailed<Data>(message?: string, data?: Data): Boom<Data>;
+export function preconditionFailed<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -370,3 +370,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -376,3 +376,3 @@ *
 */
-export function entityTooLarge<Data>(message?: string, data?: Data): Boom<Data>;
+export function entityTooLarge<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -383,3 +383,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -389,3 +389,3 @@ *
 */
-export function uriTooLong<Data>(message?: string, data?: Data): Boom<Data>;
+export function uriTooLong<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -396,3 +396,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -402,3 +402,3 @@ *
 */
-export function unsupportedMediaType<Data>(message?: string, data?: Data): Boom<Data>;
+export function unsupportedMediaType<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -409,3 +409,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -415,3 +415,3 @@ *
 */
-export function rangeNotSatisfiable<Data>(message?: string, data?: Data): Boom<Data>;
+export function rangeNotSatisfiable<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -422,3 +422,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -428,3 +428,3 @@ *
 */
-export function expectationFailed<Data>(message?: string, data?: Data): Boom<Data>;
+export function expectationFailed<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -435,3 +435,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -441,3 +441,3 @@ *
 */
-export function teapot<Data>(message?: string, data?: Data): Boom<Data>;
+export function teapot<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -448,3 +448,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -454,3 +454,3 @@ *
 */
-export function badData<Data>(message?: string, data?: Data): Boom<Data>;
+export function badData<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -461,3 +461,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -467,3 +467,3 @@ *
 */
-export function locked<Data>(message?: string, data?: Data): Boom<Data>;
+export function locked<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -474,3 +474,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -480,3 +480,3 @@ *
 */
-export function failedDependency<Data>(message?: string, data?: Data): Boom<Data>;
+export function failedDependency<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -486,3 +486,3 @@ /**
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -492,3 +492,3 @@ *
 */
-export function tooEarly<Data>(message?: string, data?: Data): Boom<Data>;
+export function tooEarly<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -499,3 +499,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -505,3 +505,3 @@ *
 */
-export function preconditionRequired<Data>(message?: string, data?: Data): Boom<Data>;
+export function preconditionRequired<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -512,3 +512,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -518,3 +518,3 @@ *
 */
-export function tooManyRequests<Data>(message?: string, data?: Data): Boom<Data>;
+export function tooManyRequests<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -525,3 +525,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -531,3 +531,3 @@ *
 */
-export function illegal<Data>(message?: string, data?: Data): Boom<Data>;
+export function illegal<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -540,3 +540,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -547,3 +547,3 @@ * @param statusCode - Optional status code override. Defaults to 500.
 */
-export function internal<Data>(message?: string, data?: Data, statusCode?: number): Boom<Data>;
+export function internal<Data>(messageOrError?: string | Error, data?: Data, statusCode?: number): Boom<Data>;
 
@@ -554,3 +554,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -560,3 +560,3 @@ *
 */
-export function badImplementation<Data>(message?: string, data?: Data): Boom<Data>;
+export function badImplementation<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -567,3 +567,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -573,3 +573,3 @@ *
 */
-export function notImplemented<Data>(message?: string, data?: Data): Boom<Data>;
+export function notImplemented<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -580,3 +580,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -586,3 +586,3 @@ *
 */
-export function badGateway<Data>(message?: string, data?: Data): Boom<Data>;
+export function badGateway<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -593,3 +593,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -599,3 +599,3 @@ *
 */
-export function serverUnavailable<Data>(message?: string, data?: Data): Boom<Data>;
+export function serverUnavailable<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;
 
@@ -606,3 +606,3 @@
 *
-* @param message - Optional message
+* @param messageOrError - Optional message or Error
 * @param data - Optional additional error data
@@ -612,2 +612,2 @@ *
 */
-export function gatewayTimeout<Data>(message?: string, data?: Data): Boom<Data>;
+export function gatewayTimeout<Data>(messageOrError?: string | Error, data?: Data): Boom<Data>;

lib/index.js

@@ -71,10 +71,10 @@ 'use strict';
 
-    constructor(message, options = {}) {
+    constructor(messageOrError, options = {}) {
 
-        if (message instanceof Error) {
-            return exports.boomify(Hoek.clone(message), options);
+        if (messageOrError instanceof Error) {
+            return exports.boomify(Hoek.clone(messageOrError), options);
         }
 
         const { statusCode = 500, data = null, ctor = exports.Boom } = options;
-        const error = new Error(message ? message : undefined);         // Avoids settings null message
+        const error = new Error(messageOrError ? messageOrError : undefined);         // Avoids settings null message
         Error.captureStackTrace(error, ctor);                           // Filter the stack to our external API
@@ -142,5 +142,5 @@ error.data = data;
 
-exports.badRequest = function (message, data) {
+exports.badRequest = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 400, data, ctor: exports.badRequest });
+    return new exports.Boom(messageOrError, { statusCode: 400, data, ctor: exports.badRequest });
 };
@@ -210,23 +210,23 @@
 
-exports.paymentRequired = function (message, data) {
+exports.paymentRequired = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 402, data, ctor: exports.paymentRequired });
+    return new exports.Boom(messageOrError, { statusCode: 402, data, ctor: exports.paymentRequired });
 };
 
 
-exports.forbidden = function (message, data) {
+exports.forbidden = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 403, data, ctor: exports.forbidden });
+    return new exports.Boom(messageOrError, { statusCode: 403, data, ctor: exports.forbidden });
 };
 
 
-exports.notFound = function (message, data) {
+exports.notFound = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 404, data, ctor: exports.notFound });
+    return new exports.Boom(messageOrError, { statusCode: 404, data, ctor: exports.notFound });
 };
 
 
-exports.methodNotAllowed = function (message, data, allow) {
+exports.methodNotAllowed = function (messageOrError, data, allow) {
 
-    const err = new exports.Boom(message, { statusCode: 405, data, ctor: exports.methodNotAllowed });
+    const err = new exports.Boom(messageOrError, { statusCode: 405, data, ctor: exports.methodNotAllowed });
 
@@ -245,118 +245,118 @@ if (typeof allow === 'string') {
 
-exports.notAcceptable = function (message, data) {
+exports.notAcceptable = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 406, data, ctor: exports.notAcceptable });
+    return new exports.Boom(messageOrError, { statusCode: 406, data, ctor: exports.notAcceptable });
 };
 
 
-exports.proxyAuthRequired = function (message, data) {
+exports.proxyAuthRequired = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 407, data, ctor: exports.proxyAuthRequired });
+    return new exports.Boom(messageOrError, { statusCode: 407, data, ctor: exports.proxyAuthRequired });
 };
 
 
-exports.clientTimeout = function (message, data) {
+exports.clientTimeout = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 408, data, ctor: exports.clientTimeout });
+    return new exports.Boom(messageOrError, { statusCode: 408, data, ctor: exports.clientTimeout });
 };
 
 
-exports.conflict = function (message, data) {
+exports.conflict = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 409, data, ctor: exports.conflict });
+    return new exports.Boom(messageOrError, { statusCode: 409, data, ctor: exports.conflict });
 };
 
 
-exports.resourceGone = function (message, data) {
+exports.resourceGone = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 410, data, ctor: exports.resourceGone });
+    return new exports.Boom(messageOrError, { statusCode: 410, data, ctor: exports.resourceGone });
 };
 
 
-exports.lengthRequired = function (message, data) {
+exports.lengthRequired = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 411, data, ctor: exports.lengthRequired });
+    return new exports.Boom(messageOrError, { statusCode: 411, data, ctor: exports.lengthRequired });
 };
 
 
-exports.preconditionFailed = function (message, data) {
+exports.preconditionFailed = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 412, data, ctor: exports.preconditionFailed });
+    return new exports.Boom(messageOrError, { statusCode: 412, data, ctor: exports.preconditionFailed });
 };
 
 
-exports.entityTooLarge = function (message, data) {
+exports.entityTooLarge = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 413, data, ctor: exports.entityTooLarge });
+    return new exports.Boom(messageOrError, { statusCode: 413, data, ctor: exports.entityTooLarge });
 };
 
 
-exports.uriTooLong = function (message, data) {
+exports.uriTooLong = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 414, data, ctor: exports.uriTooLong });
+    return new exports.Boom(messageOrError, { statusCode: 414, data, ctor: exports.uriTooLong });
 };
 
 
-exports.unsupportedMediaType = function (message, data) {
+exports.unsupportedMediaType = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 415, data, ctor: exports.unsupportedMediaType });
+    return new exports.Boom(messageOrError, { statusCode: 415, data, ctor: exports.unsupportedMediaType });
 };
 
 
-exports.rangeNotSatisfiable = function (message, data) {
+exports.rangeNotSatisfiable = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 416, data, ctor: exports.rangeNotSatisfiable });
+    return new exports.Boom(messageOrError, { statusCode: 416, data, ctor: exports.rangeNotSatisfiable });
 };
 
 
-exports.expectationFailed = function (message, data) {
+exports.expectationFailed = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 417, data, ctor: exports.expectationFailed });
+    return new exports.Boom(messageOrError, { statusCode: 417, data, ctor: exports.expectationFailed });
 };
 
 
-exports.teapot = function (message, data) {
+exports.teapot = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 418, data, ctor: exports.teapot });
+    return new exports.Boom(messageOrError, { statusCode: 418, data, ctor: exports.teapot });
 };
 
 
-exports.badData = function (message, data) {
+exports.badData = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 422, data, ctor: exports.badData });
+    return new exports.Boom(messageOrError, { statusCode: 422, data, ctor: exports.badData });
 };
 
 
-exports.locked = function (message, data) {
+exports.locked = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 423, data, ctor: exports.locked });
+    return new exports.Boom(messageOrError, { statusCode: 423, data, ctor: exports.locked });
 };
 
 
-exports.failedDependency = function (message, data) {
+exports.failedDependency = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 424, data, ctor: exports.failedDependency });
+    return new exports.Boom(messageOrError, { statusCode: 424, data, ctor: exports.failedDependency });
 };
 
-exports.tooEarly = function (message, data) {
+exports.tooEarly = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 425, data, ctor: exports.tooEarly });
+    return new exports.Boom(messageOrError, { statusCode: 425, data, ctor: exports.tooEarly });
 };
 
 
-exports.preconditionRequired = function (message, data) {
+exports.preconditionRequired = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 428, data, ctor: exports.preconditionRequired });
+    return new exports.Boom(messageOrError, { statusCode: 428, data, ctor: exports.preconditionRequired });
 };
 
 
-exports.tooManyRequests = function (message, data) {
+exports.tooManyRequests = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 429, data, ctor: exports.tooManyRequests });
+    return new exports.Boom(messageOrError, { statusCode: 429, data, ctor: exports.tooManyRequests });
 };
 
 
-exports.illegal = function (message, data) {
+exports.illegal = function (messageOrError, data) {
 
-    return new exports.Boom(message, { statusCode: 451, data, ctor: exports.illegal });
+    return new exports.Boom(messageOrError, { statusCode: 451, data, ctor: exports.illegal });
 };
@@ -459,3 +459,3 @@
 
-internals.serverError = function (message, data, statusCode, ctor) {
+internals.serverError = function (messageOrError, data, statusCode, ctor) {
 
@@ -465,6 +465,6 @@ if (data instanceof Error &&
 
-        return exports.boomify(data, { statusCode, message });
+        return exports.boomify(data, { statusCode, message: messageOrError });
     }
 
-    return new exports.Boom(message, { statusCode, data, ctor });
+    return new exports.Boom(messageOrError, { statusCode, data, ctor });
 };

package.json

 {
   "name": "@hapi/boom",
   "description": "HTTP-friendly error objects",
-  "version": "10.0.0",
+  "version": "10.0.1",
   "repository": "git://github.com/hapijs/boom",
@@ -21,3 +21,3 @@ "main": "lib/index.js",
   "dependencies": {
-    "@hapi/hoek": "10.x.x"
+    "@hapi/hoek": "^11.0.2"
   },
@@ -27,3 +27,3 @@ "devDependencies": {
     "@hapi/eslint-plugin": "*",
-    "@hapi/lab": "25.0.0-beta.1",
+    "@hapi/lab": "^25.1.0",
     "@types/node": "^17.0.31",
@@ -30,0 +30,0 @@ "typescript": "~4.6.4"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29762

increased by4.98%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@hapi/hoek@11.0.4(transitive)

• - Removed@hapi/hoek@10.0.1(transitive)

• Updated@hapi/hoek@^11.0.2