All files / namespace/pkg2related/lib main.js

100% Statements 60/60
100% Branches 9/9
100% Functions 1/1
100% Lines 60/60

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 617x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 6308x 6308x 9x 9x 6308x 3151x 3151x 3148x 6307x 3144x 3144x 4x 6308x 7x 7x 7x 7x 7x  
/**
* @license Apache-2.0
*
* Copyright (c) 2019 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 standalone2pkg = require( '@stdlib/namespace/standalone2pkg' );
var format = require( '@stdlib/string/format' );
var PKG_TO_RELATED = require( './../data/data.json' );
 
 
// MAIN //
 
/**
* Returns package names related to a specified package name.
*
* @param {string} pkg - package name
* @throws {TypeError} must provide a string
* @returns {(Array|StringArray|null)} related package names
*
* @example
* var v = pkg2related( '@stdlib/math/base/special/sin' );
* // returns [...]
*/
function pkg2related( pkg ) {
	if ( !isString( pkg ) ) {
		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', pkg ) );
	}
	if ( hasOwnProp( PKG_TO_RELATED, pkg ) ) {
		return PKG_TO_RELATED[ pkg ].slice();
	}
	pkg = standalone2pkg( pkg );
	if ( hasOwnProp( PKG_TO_RELATED, pkg ) ) {
		return PKG_TO_RELATED[ pkg ];
	}
	return null;
}
 
 
// EXPORTS //
 
module.exports = pkg2related;