fmtprodmsgFactory

Return a function which formats an error message for production.

Installation

npm install @stdlib/error-tools-fmtprodmsg-factory

Usage

var fmtprodmsgFactory = require( '@stdlib/error-tools-fmtprodmsg-factory' );

fmtprodmsgFactory( [options] )

Returns a function which formats an error message for production.

var opts = {};
var fcn = fmtprodmsgFactory( opts );
// returns <Function>

var msg = fcn( '3' );
// returns 'Minified stdlib error code: 3. Visit https://stdlib.io/docs/api/latest/error-decoder.html?code=3 for the full message.'

The function accepts the following options:

• url: website URL for full error message.
• message: error message template with {{url}} and {{code}} placeholders that will be replaced.

To set a custom URL, use the url option:

var opts = {
    'url': 'https://stdlib.io/error-decoder.html'
};

var fcn = fmtprodmsgFactory( opts );
// returns <Function>

var msg = fcn( '8' );
// returns 'Minified stdlib error code: 8. Visit https://stdlib.io/error-decoder.html?code=8 for the full message.'

To change the error message template, use the message option:

var opts = {
    'message': 'Error code: {{code}}. See: {{url}}.'
};

var fcn = fmtprodmsgFactory( opts );
// returns <Function>

var msg = fcn( '27', 'foo', 'bar' );
// returns 'Error code: 27. See: https://stdlib.io/docs/api/latest/error-decoder.html?code=27&arg[]=foo&arg[]=bar.'

Examples

var fmtprodmsgFactory = require( '@stdlib/error-tools-fmtprodmsg-factory' );

var formatProdErrorMessage = fmtprodmsgFactory();
var msg = formatProdErrorMessage( '3', 'foo' );
// returns 'Minified stdlib error code: 3. Visit https://stdlib.io/docs/api/latest/error-decoder.html?code=3&arg[]=foo for the full message.'

msg = formatProdErrorMessage( '5', 'foo', 'bar' );
// returns 'Minified stdlib error code: 5. Visit https://stdlib.io/docs/api/latest/error-decoder.html?code=5&arg[]=foo&arg[]=bar for the full message.'

msg = formatProdErrorMessage( '5', 'foo', 'bar', 123 );
// returns 'Minified stdlib error code: 5. Visit https://stdlib.io/docs/api/latest/error-decoder.html?code=5&arg[]=foo&arg[]=bar&arg[]=123 for the full message.'

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.