From d37d7e1fdf034ae36aba3e12d7499d8f6c02c04c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Mar 2025 00:45:21 +0000 Subject: [PATCH] Transform error messages --- lib/factory.js | 4 ++-- lib/main.js | 14 +++++++------- lib/object_mode.js | 4 ++-- lib/validate.js | 14 +++++++------- package.json | 2 +- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index b19b1f9..c948c8b 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -21,7 +21,7 @@ // MODULES // var isObject = require( '@stdlib/assert-is-plain-object' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var assign = require( '@stdlib/object-assign' ); var StridedArrayStream = require( './main.js' ); @@ -69,7 +69,7 @@ function factory( options ) { var opts; if ( arguments.length ) { if ( !isObject( options ) ) { - throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + throw new TypeError( format( '1MH2V', options ) ); } opts = assign( {}, options ); } else { diff --git a/lib/main.js b/lib/main.js index 62e2ca5..404a38b 100644 --- a/lib/main.js +++ b/lib/main.js @@ -32,7 +32,7 @@ var setNonEnumerable = require( '@stdlib/utils-define-nonenumerable-property' ); var setNonEnumerableReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); var string2buffer = require( '@stdlib/buffer-from-string' ); var Buffer = require( '@stdlib/buffer-ctor' ); // TODO: replace Buffer.concat usage with stdlib pkg -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var nextTick = require( '@stdlib/utils-next-tick' ); var DEFAULTS = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -83,7 +83,7 @@ function read() { v = Buffer.concat( [ string2buffer( this._sep ), v ] ); } } else { - err = new Error( format( 'invalid operation. Serialization function must return a string or Buffer. Value: `%s`.', v ) ); + err = new Error( format( '1MHA9', v ) ); } } if ( err ) { @@ -190,21 +190,21 @@ function StridedArrayStream( N, buffer, stride, offset, options ) { return new StridedArrayStream( N, buffer, stride, offset ); } if ( !isNonNegativeInteger( N ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', N ) ); + throw new TypeError( format( '1MH2d', N ) ); } if ( !isCollection( buffer ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array-like object. Value: `%s`.', buffer ) ); + throw new TypeError( format( '1MH2y', buffer ) ); } if ( !isInteger( stride ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an integer. Value: `%s`.', stride ) ); + throw new TypeError( format( '1MH2z', stride ) ); } if ( !isNonNegativeInteger( offset ) ) { - throw new TypeError( format( 'invalid argument. Fourth argument must be a nonnegative integer. Value: `%s`.', offset ) ); + throw new TypeError( format( '1MH30', offset ) ); } if ( N > 0 ) { i = offset + ((N-1)*stride); if ( offset >= buffer.length || i < 0 || i >= buffer.length ) { - throw new RangeError( 'invalid arguments. Strided array parameters are incompatible with the provided array-like object. Linear index exceeds array bounds.' ); + throw new RangeError( format('1MH1K') ); } } opts = assign( {}, DEFAULTS ); diff --git a/lib/object_mode.js b/lib/object_mode.js index c0c7043..08ffb8c 100644 --- a/lib/object_mode.js +++ b/lib/object_mode.js @@ -21,7 +21,7 @@ // MODULES // var isObject = require( '@stdlib/assert-is-plain-object' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var assign = require( '@stdlib/object-assign' ); var StridedArrayStream = require( './main.js' ); @@ -70,7 +70,7 @@ function objectMode( N, buffer, stride, offset, options ) { if ( arguments.length > 4 ) { opts = options; if ( !isObject( opts ) ) { - throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', opts ) ); + throw new TypeError( format( '1MH2V', opts ) ); } opts = assign( {}, options ); } else { diff --git a/lib/validate.js b/lib/validate.js index 2f4fce4..72c2119 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -26,7 +26,7 @@ var isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive; var isNonNegative = require( '@stdlib/assert-is-nonnegative-number' ).isPrimitive; var isString = require( '@stdlib/assert-is-string' ).isPrimitive; var isFunction = require( '@stdlib/assert-is-function' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -56,36 +56,36 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1MH2V', options ) ); } if ( hasOwnProp( options, 'sep' ) ) { opts.sep = options.sep; if ( !isString( opts.sep ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a string. Option: `%s`.', 'sep', opts.sep ) ); + return new TypeError( format( '1MH2W', 'sep', opts.sep ) ); } } if ( hasOwnProp( options, 'objectMode' ) ) { opts.objectMode = options.objectMode; if ( !isBoolean( opts.objectMode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'objectMode', opts.objectMode ) ); + return new TypeError( format( '1MH2o', 'objectMode', opts.objectMode ) ); } } if ( hasOwnProp( options, 'encoding' ) ) { opts.encoding = options.encoding; if ( !isString( opts.encoding ) && opts.encoding !== null ) { - return new TypeError( format( 'invalid option. `%s` option must be a string or null. Option: `%s`.', 'encoding', opts.encoding ) ); + return new TypeError( format( '1MH7n', 'encoding', opts.encoding ) ); } } if ( hasOwnProp( options, 'highWaterMark' ) ) { opts.highWaterMark = options.highWaterMark; if ( !isNonNegative( opts.highWaterMark ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a nonnegative number. Option: `%s`.', 'highWaterMark', opts.highWaterMark ) ); + return new TypeError( format( '1MH4k', 'highWaterMark', opts.highWaterMark ) ); } } if ( hasOwnProp( options, 'serialize' ) ) { opts.serialize = options.serialize; if ( !isFunction( opts.serialize ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a function. Option: `%s`.', 'serialize', opts.serialize ) ); + return new TypeError( format( '1MH6p', 'serialize', opts.serialize ) ); } } return null; diff --git a/package.json b/package.json index f1b0265..f25e483 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "@stdlib/buffer-ctor": "^0.2.2", "@stdlib/buffer-from-string": "^0.2.2", "@stdlib/object-assign": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-property": "^0.2.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",