README.md (1690B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # dirname 22 23 > Return a [directory name][dirname]. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var dirname = require( '@stdlib/utils/dirname' ); 31 ``` 32 33 #### dirname( path ) 34 35 Returns a [directory name][dirname]. 36 37 ```javascript 38 var dir = dirname( './foo/bar/index.js' ); 39 // returns './foo/bar' 40 ``` 41 42 </section> 43 44 <!-- /.usage --> 45 46 <section class="examples"> 47 48 ## Examples 49 50 <!-- eslint no-undef: "error" --> 51 52 ```javascript 53 var statSync = require( 'fs' ).statSync; 54 var path = require( 'path' ); 55 var readDir = require( '@stdlib/fs/read-dir' ).sync; 56 var dirname = require( '@stdlib/utils/dirname' ); 57 58 var files; 59 var fpath; 60 var base; 61 var stat; 62 var dir; 63 var i; 64 65 base = path.resolve( __dirname, '..' ); 66 files = readDir( base ); 67 68 for ( i = 0; i < files.length; i++ ) { 69 fpath = path.join( base, files[ i ] ); 70 stat = statSync( fpath ); 71 if ( !stat.isDirectory() ) { 72 dir = dirname( fpath ); 73 console.log( '%s --> %s', fpath, dir ); 74 } 75 } 76 ``` 77 78 </section> 79 80 <!-- /.examples --> 81 82 <section class="links"> 83 84 [dirname]: https://en.wikipedia.org/wiki/Dirname 85 86 </section> 87 88 <!-- /.links -->