Noiseless Peaceful Morning

    @stdlib/error-tools-fmtprodmsg
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.1 • Public • Published

    formatProdErrorMessage

    NPM version Build Status Coverage Status

    Format an error message for production.

    Installation

    npm install @stdlib/error-tools-fmtprodmsg

    Usage

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

    formatProdErrorMessage( code, ...args )

    Formats an error message for production.

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

    formatProdErrorMessage.factory( options )

    Returns a function which formats an error message for production.

    var opts = {};
    var fcn = formatProdErrorMessage.factory( 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 = formatProdErrorMessage.factory( 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 = formatProdErrorMessage.factory( 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 formatProdErrorMessage = require( '@stdlib/error-tools-fmtprodmsg' );
    
    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/error-tools-fmtprodmsg

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    54

    Version

    0.0.1

    License

    Apache-2.0

    Unpacked Size

    44.4 kB

    Total Files

    11

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser