Gathering detailed insights and metrics for @stdlib/error-tools-fmtprodmsg-factory
Gathering detailed insights and metrics for @stdlib/error-tools-fmtprodmsg-factory
Return a function which formats an error message for production.
npm install @stdlib/error-tools-fmtprodmsg-factory
Typescript
Module System
Min. Node Version
Node Version
NPM Version
70.1
Supply Chain
87.7
Quality
82.1
Maintenance
100
Vulnerability
88
License
JavaScript (100%)
Love this project? Help keep it running — sponsor us today! 🚀
Total Downloads
1,645
Last Day
4
Last Week
8
Last Month
59
Last Year
678
Apache-2.0 License
2 Stars
49 Commits
3 Watchers
6 Branches
11 Contributors
Updated on Feb 03, 2025
Minified
Minified + Gzipped
Latest Version
0.2.2
Package Id
@stdlib/error-tools-fmtprodmsg-factory@0.2.2
Unpacked Size
36.27 kB
Size
9.53 kB
File Count
13
NPM Version
8.19.4
Node Version
16.20.2
Published on
Jul 27, 2024
Cumulative downloads
Total Downloads
Last Day
0%
4
Compared to previous day
Last Week
-20%
8
Compared to previous week
Last Month
110.7%
59
Compared to previous month
Last Year
1.3%
678
Compared to previous year
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!
Return a
function
which formats an error message for production.
1npm install @stdlib/error-tools-fmtprodmsg-factory
1var fmtprodmsgFactory = require( '@stdlib/error-tools-fmtprodmsg-factory' );
Returns a function
which formats an error message for production.
1var opts = {}; 2var fcn = fmtprodmsgFactory( opts ); 3// returns <Function> 4 5var msg = fcn( '3' ); 6// 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}}
and {{code}}
placeholders that will be replaced.To set a custom URL, use the url
option:
1var opts = { 2 'url': 'https://stdlib.io/error-decoder.html' 3}; 4 5var fcn = fmtprodmsgFactory( opts ); 6// returns <Function> 7 8var msg = fcn( '8' ); 9// 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:
1var opts = { 2 'message': 'Error code: {{code}}. See: {{url}}.' 3}; 4 5var fcn = fmtprodmsgFactory( opts ); 6// returns <Function> 7 8var msg = fcn( '27', 'foo', 'bar' ); 9// returns 'Error code: 27. See: https://stdlib.io/docs/api/latest/error-decoder.html?code=27&arg[]=foo&arg[]=bar.'
1var fmtprodmsgFactory = require( '@stdlib/error-tools-fmtprodmsg-factory' ); 2 3var formatProdErrorMessage = fmtprodmsgFactory(); 4var msg = formatProdErrorMessage( '3', 'foo' ); 5// returns 'Minified stdlib error code: 3. Visit https://stdlib.io/docs/api/latest/error-decoder.html?code=3&arg[]=foo for the full message.' 6 7msg = formatProdErrorMessage( '5', 'foo', 'bar' ); 8// 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.' 9 10msg = formatProdErrorMessage( '5', 'foo', 'bar', 123 ); 11// 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.'
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.
No vulnerabilities found.
No security vulnerabilities found.