@stdlib/error/tools/id2msg/lib/main.js

Errors.

/**
* @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.
*/

'use strict';

// MODULES //

var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var database = require( './../../../tools/database' );
var format = require( '@stdlib/string/format' );


// VARIABLES //

var db;


// MAIN //

/**
* Returns an error message corresponding to a provided two-character error identifier.
*
* @param {string} id - error identifier
* @throws {TypeError} must provide a string
* @returns {(string|null)} error message
*
* @example
* var v = id2msg( '9b' );
* // returns <string>
*
* @example
* var v = id2msg( 'boop' );
* // returns null
*/
function id2msg( id ) {
	if ( !isString( id ) ) {
		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', id ) );
	}
	if ( !db ) {
		db = database();
	}
	if ( hasOwnProp( db, id ) ) {
		return db[ id ];
	}
	return null;
}


// EXPORTS //

module.exports = id2msg;