time-to-botec/js/node_modules/@stdlib/utils/dirname/lib/dirname.js

51 lines
1.2 KiB
JavaScript
Raw Permalink Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 RE_DIRNAME = require( '@stdlib/regexp/dirname' ).REGEXP;
// MAIN //
/**
* Returns a path dirname.
*
* @param {string} path - path
* @throws {TypeError} must provide a string primitive
* @returns {string} directory name
*
* @example
* var dir = dirname( './foo/bar/index.js' );
* // returns './foo/bar'
*/
function dirname( path ) {
if ( !isString( path ) ) {
throw new TypeError( 'invalid argument. Path must be a primitive string. Value: `' + path + '`.' );
}
return RE_DIRNAME.exec( path )[ 1 ];
}
// EXPORTS //
module.exports = dirname;