Skip to content

Latest commit

 

History

History
238 lines (152 loc) · 8 KB

README.md

File metadata and controls

238 lines (152 loc) · 8 KB
Raw
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

fmtprodmsgFactory

NPM version Build Status Coverage Status

Return a function which formats an error message for production.

Usage

To use in Observable,

fmtprodmsgFactory = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg-factory@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var fmtprodmsgFactory = require( 'path/to/vendor/umd/error-tools-fmtprodmsg-factory/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg-factory@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.fmtprodmsgFactory;
})();
</script>

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

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg-factory@umd/browser.js"></script>
<script type="text/javascript">
(function () {

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.'

})();
</script>
</body>
</html>

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.