UNPKG

@stdlib/error

Version:
92 lines (54 loc) 2.05 kB
<!-- @license Apache-2.0 Copyright (c) 2022 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> # fmtprodmsg > Format an error message for production. <section class="usage"> ## Usage ```javascript var fmtprodmsg = require( '@stdlib/error/tools/fmtprodmsg' ); ``` #### fmtprodmsg( code, ...args ) Formats an error message for production. ```javascript var msg = fmtprodmsg( '27', 'foo', 'bar' ); // returns 'https://stdlib.io/e/27?arg[]=foo&arg[]=bar' ``` <!-- /.usage --> <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> <section class="notes"> </section> <!-- /.notes --> <section class="examples"> ## Examples <!-- TODO: better examples --> <!-- eslint no-undef: "error" --> ```javascript var fmtprodmsg = require( '@stdlib/error/tools/fmtprodmsg' ); var msg = fmtprodmsg( '3', 'foo' ); // returns 'https://stdlib.io/e?code=3&arg[]=foo' msg = fmtprodmsg( '5', 'foo', 'bar' ); // returns 'https://stdlib.io/e/5?arg[]=foo&arg[]=bar' msg = fmtprodmsg( '5', 'foo', 'bar', 123 ); // returns 'https://stdlib.io/e/5?arg[]=foo&arg[]=bar&arg[]=123' ``` </section> <!-- /.examples --> <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> <section class="related"> </section> <!-- /.related --> <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> <section class="links"> </section> <!-- /.links -->