@stdlib/error-tools-pkg2id NPM

pkg2id

Return the error identifier prefix associated with a specified package name.

Installation

npm install @stdlib/error-tools-pkg2id

Usage

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

pkg2id( pkg )

Returns the error identifier prefix associated with a specified package name.

var v = pkg2id( '@stdlib/math-base-special-sin' );
// returns '0YK'

If provided an unrecognized pkg, the function returns null.

var v = pkg2id( 'unrecognized_pkg_beep_boop_bop_bip' );
// returns null

Notes

The function supports providing both internal and standalone package names.
```
var v = pkg2id( '@stdlib/math-base-special-sin' );
// returns '0YK'
```

Examples

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

var prefix = pkg2id( '@stdlib/math-base-special-sin' );
var errorCode = '23';
var code = prefix + errorCode;

var msg = formatProdErrorMessage( code );
console.log( msg );
// => <string>

License

The data files (databases) are licensed under an Open Data Commons Public Domain Dedication & License 1.0 and their contents are licensed under Creative Commons Zero v1.0 Universal. The software is licensed under Apache License, Version 2.0.

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.