feat!: rename error codes

kgryte · kgryte · commit 82dea00133a0 · 2023-09-18T17:04:49.000-07:00
This commit adds a `SLICE_` prefix to error codes to help distinguish
the relevant error codes from other errors across the code base
which might have similar error names. This namespacing convention
follows Node.js core conventions.

BREAKING CHANGE: rename error codes

To migrate, if users were checking for particular error codes, they
should add the `SLICE_` prefix to their checks.
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/README.md b/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/README.md
@@ -106,12 +106,12 @@ var MultiSlice = require( '@stdlib/slice/multi' );
 
 var s1 = new MultiSlice( new Slice( -20, 20, 1 ) );
 var s2 = normalizeMultiSlice( s1, [ 10 ], true );
-// returns { 'code': 'ERR_OUT_OF_BOUNDS' }
+// returns { 'code': 'ERR_SLICE_OUT_OF_BOUNDS' }
 ```
 
 A returned error object may have one of the following error codes:
 
--   **ERR_OUT_OF_BOUNDS**: a slice exceeds index bounds.
+-   **ERR_SLICE_OUT_OF_BOUNDS**: a slice exceeds index bounds.
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/docs/repl.txt b/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/docs/repl.txt
@@ -11,7 +11,7 @@
 
     A returned error object may have one of the following error codes:
 
-    - ERR_OUT_OF_BOUNDS: a slice exceeds index bounds.
+    - ERR_SLICE_OUT_OF_BOUNDS: a slice exceeds index bounds.
 
     Parameters
     ----------
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/docs/types/index.d.ts b/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/docs/types/index.d.ts
@@ -30,7 +30,7 @@ interface ErrorObject {
 	/**
 	* Error code.
 	*/
-	code: 'ERR_OUT_OF_BOUNDS';
+	code: 'ERR_SLICE_OUT_OF_BOUNDS';
 }
 
 /**
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/lib/error_out_of_bounds.js b/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/lib/error_out_of_bounds.js
@@ -28,7 +28,7 @@
 */
 function error() {
 	return {
-		'code': 'ERR_OUT_OF_BOUNDS'
+		'code': 'ERR_SLICE_OUT_OF_BOUNDS'
 	};
 }
 
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/test/test.js b/lib/node_modules/@stdlib/slice/base/normalize-multi-slice/test/test.js
@@ -296,7 +296,7 @@ tape( 'in strict mode, the function returns an error object when a slice exceeds
 		new MultiSlice( -6, 12, -10, 2 )
 	];
 	expected = {
-		'code': 'ERR_OUT_OF_BOUNDS'
+		'code': 'ERR_SLICE_OUT_OF_BOUNDS'
 	};
 
 	for ( i = 0; i < values.length; i++ ) {
@@ -327,7 +327,7 @@ tape( 'in strict mode, the function returns an error object when a slice exceeds
 		new MultiSlice( new Slice( -30, -20, 1 ) )
 	];
 	expected = {
-		'code': 'ERR_OUT_OF_BOUNDS'
+		'code': 'ERR_SLICE_OUT_OF_BOUNDS'
 	};
 
 	for ( i = 0; i < values.length; i++ ) {
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-slice/README.md b/lib/node_modules/@stdlib/slice/base/normalize-slice/README.md
@@ -68,12 +68,12 @@ When `strict` is `true`, the function returns an error object if an input slice
 var Slice = require( '@stdlib/slice/ctor' );
 
 var s = normalizeSlice( new Slice( -20, 20, 1 ), 10, true );
-// returns { 'code': 'ERR_OUT_OF_BOUNDS' }
+// returns { 'code': 'ERR_SLICE_OUT_OF_BOUNDS' }
 ```
 
 A returned error object may have one of the following error codes:
 
--   **ERR_OUT_OF_BOUNDS**: a slice exceeds index bounds.
+-   **ERR_SLICE_OUT_OF_BOUNDS**: a slice exceeds index bounds.
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-slice/docs/repl.txt b/lib/node_modules/@stdlib/slice/base/normalize-slice/docs/repl.txt
@@ -11,7 +11,7 @@
 
     A returned error object may have one of the following error codes:
 
-    - ERR_OUT_OF_BOUNDS: a slice exceeds index bounds.
+    - ERR_SLICE_OUT_OF_BOUNDS: a slice exceeds index bounds.
 
     Parameters
     ----------
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-slice/docs/types/index.d.ts b/lib/node_modules/@stdlib/slice/base/normalize-slice/docs/types/index.d.ts
@@ -29,7 +29,7 @@ interface ErrorObject {
 	/**
 	* Error code.
 	*/
-	code: 'ERR_OUT_OF_BOUNDS';
+	code: 'ERR_SLICE_OUT_OF_BOUNDS';
 }
 
 /**
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-slice/lib/error_out_of_bounds.js b/lib/node_modules/@stdlib/slice/base/normalize-slice/lib/error_out_of_bounds.js
@@ -28,7 +28,7 @@
 */
 function error() {
 	return {
-		'code': 'ERR_OUT_OF_BOUNDS'
+		'code': 'ERR_SLICE_OUT_OF_BOUNDS'
 	};
 }
 
diff --git a/lib/node_modules/@stdlib/slice/base/normalize-slice/test/test.js b/lib/node_modules/@stdlib/slice/base/normalize-slice/test/test.js
@@ -169,7 +169,7 @@ tape( 'in strict mode, the function returns an error object when a slice exceeds
 		new Slice( null, -20, 1 )
 	];
 	expected = {
-		'code': 'ERR_OUT_OF_BOUNDS'
+		'code': 'ERR_SLICE_OUT_OF_BOUNDS'
 	};
 
 	for ( i = 0; i < values.length; i++ ) {
diff --git a/lib/node_modules/@stdlib/slice/base/seq2slice/README.md b/lib/node_modules/@stdlib/slice/base/seq2slice/README.md
@@ -118,21 +118,21 @@ The function returns an error object if provided in invalid subsequence string.
 
 ```javascript
 var s = seq2slice( '1:2:3:4', 10, false );
-// returns { 'code': 'ERR_INVALID_SUBSEQUENCE' }
+// returns { 'code': 'ERR_SLICE_INVALID_SUBSEQUENCE' }
 ```
 
 When `strict` is `true`, the function returns an error object if a subsequence string resolves to a slice exceeding index bounds.
 
 ```javascript
 var s = seq2slice( '10:20', 10, true );
-// returns { 'code': 'ERR_OUT_OF_BOUNDS' }
+// returns { 'code': 'ERR_SLICE_OUT_OF_BOUNDS' }
 ```
 
 A returned error object may have one of the following error codes:
 
--   **ERR_INVALID_SUBSEQUENCE**: a subsequence string is invalid.
--   **ERR_INVALID_INCREMENT**: a subsequence string must have a non-zero increment.
--   **ERR_OUT_OF_BOUNDS**: a subsequence string resolves to a slice exceeding index bounds.
+-   **ERR_SLICE_INVALID_SUBSEQUENCE**: a subsequence string is invalid.
+-   **ERR_SLICE_INVALID_INCREMENT**: a subsequence string must have a non-zero increment.
+-   **ERR_SLICE_OUT_OF_BOUNDS**: a subsequence string resolves to a slice exceeding index bounds.
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/slice/base/seq2slice/docs/repl.txt b/lib/node_modules/@stdlib/slice/base/seq2slice/docs/repl.txt
@@ -59,11 +59,11 @@
 
     A returned error object may have one of the following error codes:
 
-    - ERR_INVALID_SUBSEQUENCE: a subsequence string is invalid.
-    - ERR_INVALID_INCREMENT: a subsequence string must have a non-zero
+    - ERR_SLICE_INVALID_SUBSEQUENCE: a subsequence string is invalid.
+    - ERR_SLICE_INVALID_INCREMENT: a subsequence string must have a non-zero
       increment.
-    - ERR_OUT_OF_BOUNDS: a subsequence string resolves to a slice exceeding
-      index bounds.
+    - ERR_SLICE_OUT_OF_BOUNDS: a subsequence string resolves to a slice
+      exceeding index bounds.
 
     Parameters
     ----------
diff --git a/lib/node_modules/@stdlib/slice/base/seq2slice/docs/types/index.d.ts b/lib/node_modules/@stdlib/slice/base/seq2slice/docs/types/index.d.ts
@@ -29,7 +29,7 @@ interface ErrorObject {
 	/**
 	* Error code.
 	*/
-	code: 'ERR_INVALID_SUBSEQUENCE' | 'ERR_INVALID_INCREMENT' | 'ERR_OUT_OF_BOUNDS';
+	code: 'ERR_SLICE_INVALID_SUBSEQUENCE' | 'ERR_SLICE_INVALID_INCREMENT' | 'ERR_SLICE_OUT_OF_BOUNDS';
 }
 
 /**
diff --git a/lib/node_modules/@stdlib/slice/base/seq2slice/lib/error_invalid_increment.js b/lib/node_modules/@stdlib/slice/base/seq2slice/lib/error_invalid_increment.js
@@ -28,7 +28,7 @@
 */
 function error() {
 	return {
-		'code': 'ERR_INVALID_INCREMENT'
+		'code': 'ERR_SLICE_INVALID_INCREMENT'
 	};
 }
 
diff --git a/lib/node_modules/@stdlib/slice/base/seq2slice/lib/error_invalid_subsequence.js b/lib/node_modules/@stdlib/slice/base/seq2slice/lib/error_invalid_subsequence.js
@@ -28,7 +28,7 @@
 */
 function error() {
 	return {
-		'code': 'ERR_INVALID_SUBSEQUENCE'
+		'code': 'ERR_SLICE_INVALID_SUBSEQUENCE'
 	};
 }
 
diff --git a/lib/node_modules/@stdlib/slice/base/seq2slice/lib/error_out_of_bounds.js b/lib/node_modules/@stdlib/slice/base/seq2slice/lib/error_out_of_bounds.js
@@ -28,7 +28,7 @@
 */
 function error() {
 	return {
-		'code': 'ERR_OUT_OF_BOUNDS'
+		'code': 'ERR_SLICE_OUT_OF_BOUNDS'
 	};
 }
 
diff --git a/lib/node_modules/@stdlib/slice/base/seq2slice/test/test.js b/lib/node_modules/@stdlib/slice/base/seq2slice/test/test.js
@@ -98,7 +98,7 @@ tape( 'the function returns an error object if provided a first argument which i
 		':end/1s'
 	];
 	expected = {
-		'code': 'ERR_INVALID_SUBSEQUENCE'
+		'code': 'ERR_SLICE_INVALID_SUBSEQUENCE'
 	};
 	for ( i = 0; i < values.length; i++ ) {
 		t.deepEqual( seq2slice( values[ i ], 10, false ), expected, 'returns expected value when provided ' + values[ i ] );
@@ -119,7 +119,7 @@ tape( 'the function returns an error object if provided a first argument which i
 		':end/0.5:'
 	];
 	expected = {
-		'code': 'ERR_INVALID_SUBSEQUENCE'
+		'code': 'ERR_SLICE_INVALID_SUBSEQUENCE'
 	};
 	for ( i = 0; i < values.length; i++ ) {
 		t.deepEqual( seq2slice( values[ i ], 10, false ), expected, 'returns expected value when provided ' + values[ i ] );
@@ -159,7 +159,7 @@ tape( 'the function returns an error object if provided a first argument which i
 		':end-20:5'
 	];
 	expected = {
-		'code': 'ERR_OUT_OF_BOUNDS'
+		'code': 'ERR_SLICE_OUT_OF_BOUNDS'
 	};
 	for ( i = 0; i < values.length; i++ ) {
 		t.deepEqual( seq2slice( values[ i ], 10, true ), expected, 'returns expected value when provided ' + values[ i ] );
@@ -182,7 +182,7 @@ tape( 'the function returns an error object if provided a first argument which i
 		'end:end:0'
 	];
 	expected = {
-		'code': 'ERR_INVALID_INCREMENT'
+		'code': 'ERR_SLICE_INVALID_INCREMENT'
 	};
 	for ( i = 0; i < values.length; i++ ) {
 		t.deepEqual( seq2slice( values[ i ], 10, false ), expected, 'returns expected value when provided ' + values[ i ] );
diff --git a/lib/node_modules/@stdlib/slice/seq2slice/lib/main.js b/lib/node_modules/@stdlib/slice/seq2slice/lib/main.js
@@ -347,13 +347,13 @@ function seq2slice( str, len, strict ) {
 	if ( code === void 0 ) {
 		return s;
 	}
-	if ( code === 'ERR_INVALID_INCREMENT' ) {
+	if ( code === 'ERR_SLICE_INVALID_INCREMENT' ) {
 		throw new RangeError( format( 'invalid argument. A subsequence string must have a non-zero increment. Value: `%s`.', str ) );
 	}
-	if ( code === 'ERR_OUT_OF_BOUNDS' ) {
+	if ( code === 'ERR_SLICE_OUT_OF_BOUNDS' ) {
 		throw new RangeError( format( 'invalid argument. The subsequence string resolves to a slice which exceeds index bounds. Value: `%s`.', str ) );
 	}
-	// code === 'ERR_INVALID_SUBSEQUENCE'
+	// code === 'ERR_SLICE_INVALID_SUBSEQUENCE'
 	throw new TypeError( format( 'invalid argument. First argument must be a valid subsequence string. Value: `%s`.', str ) );
 }
 

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ interface ErrorObject {`
`30`	`30`	`/**`
`31`	`31`	`* Error code.`
`32`	`32`	`*/`
`33`		`- code: 'ERR_OUT_OF_BOUNDS';`
	`33`	`+ code: 'ERR_SLICE_OUT_OF_BOUNDS';`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`*/`
`29`	`29`	`function error() {`
`30`	`30`	`return {`
`31`		`- 'code': 'ERR_OUT_OF_BOUNDS'`
	`31`	`+ 'code': 'ERR_SLICE_OUT_OF_BOUNDS'`
`32`	`32`	`};`
`33`	`33`	`}`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ interface ErrorObject {`
`29`	`29`	`/**`
`30`	`30`	`* Error code.`
`31`	`31`	`*/`
`32`		`- code: 'ERR_OUT_OF_BOUNDS';`
	`32`	`+ code: 'ERR_SLICE_OUT_OF_BOUNDS';`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/**`