@dotcom-reliability-kit/errors - npm Package Compare versions

Comparing version 1.2.2 to 1.2.3

lib/data-store-error.js

@@ -1,5 +0,1 @@
-/**
- * @module @dotcom-reliability-kit/errors/lib/data-store-error
- */
-
 const OperationalError = require('./operational-error');
@@ -13,3 +9,3 @@
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {string}
@@ -16,0 +12,0 @@ */

lib/http-error.js

@@ -1,5 +0,1 @@
-/**
- * @module @dotcom-reliability-kit/errors/lib/http-error
- */
-
 const OperationalError = require('./operational-error');
@@ -29,3 +25,3 @@
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {string}
@@ -37,3 +33,3 @@ */
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {number}
@@ -45,3 +41,3 @@ */
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {string}
@@ -53,3 +49,3 @@ */
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {number}
@@ -106,3 +102,3 @@ */
 	 *
-	 * @access private
+	 * @protected
 	 * @type {Array<string>}
@@ -119,3 +115,3 @@ */
 	 *
-	 * @access private
+	 * @protected
 	 * @param {number} statusCode
@@ -137,3 +133,3 @@ *     The HTTP status code to normalize.
 	 *
-	 * @access private
+	 * @private
 	 * @param {number} statusCode
@@ -140,0 +136,0 @@ *     The HTTP status code to get a message for.

lib/index.js

@@ -1,11 +0,9 @@
-/**
- * @module @dotcom-reliability-kit/errors
- */
+module.exports = {
+	DataStoreError: require('./data-store-error'),
+	HttpError: require('./http-error'),
+	OperationalError: require('./operational-error'),
+	UpstreamServiceError: require('./upstream-service-error'),
+	UserInputError: require('./user-input-error')
+};
 
-exports.DataStoreError = require('./data-store-error');
-exports.HttpError = require('./http-error');
-exports.OperationalError = require('./operational-error');
-exports.UpstreamServiceError = require('./upstream-service-error');
-exports.UserInputError = require('./user-input-error');
-
-exports.default = exports;
+module.exports.default = module.exports;

lib/operational-error.js

 /**
- * @module @dotcom-reliability-kit/errors/lib/operational-error
- */
-
-/**
  * @typedef {object} OperationalErrorData
@@ -23,3 +19,3 @@ * @property {string} [code]
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {string}
@@ -33,3 +29,3 @@ */
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {boolean}
@@ -43,3 +39,3 @@ */
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {string}
@@ -54,3 +50,3 @@ */
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {Array<string>}
@@ -64,3 +60,3 @@ */
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {Error|null}
@@ -74,3 +70,3 @@ */
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {Object<string, any>}
@@ -119,3 +115,3 @@ */
 	 *
-	 * @access private
+	 * @protected
 	 * @type {Array<string>}
@@ -143,3 +139,3 @@ */
 	 *
-	 * @access private
+	 * @private
 	 * @param {string} code
@@ -146,0 +142,0 @@ *     The error code to normalize.

lib/upstream-service-error.js

@@ -1,5 +0,1 @@
-/**
- * @module @dotcom-reliability-kit/errors/lib/upstream-service-error
- */
-
 const HttpError = require('./http-error');
@@ -13,3 +9,3 @@
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {string}
@@ -16,0 +12,0 @@ */

lib/user-input-error.js

@@ -1,5 +0,1 @@
-/**
- * @module @dotcom-reliability-kit/errors/lib/user-input-error
- */
-
 const HttpError = require('./http-error');
@@ -13,3 +9,3 @@
 	 * @readonly
-	 * @access public
+	 * @public
 	 * @type {string}
@@ -16,0 +12,0 @@ */

package.json

 {
   "name": "@dotcom-reliability-kit/errors",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "A suite of error classes which help you throw the most appropriate error in any situation",
@@ -5,0 +5,0 @@ "repository": {

No alert changes

Worsened metrics

Total package byte prevSize

18874

decreased by-2.77%

Lines of code

364

decreased by-4.21%

No dependency changes