sync.js (1192B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var readdirSync = require( 'fs' ).readdirSync; // eslint-disable-line no-sync 24 25 26 // MAIN // 27 28 /** 29 * Synchronously reads the contents of a directory. 30 * 31 * @param {(string|Buffer)} path - directory path 32 * @returns {(StringArray|Error)} directory contents or an error 33 * 34 * @example 35 * var out = readDirSync( __dirname ); 36 * if ( out instanceof Error ) { 37 * throw out; 38 * } 39 * console.log( out ); 40 */ 41 function readDirSync( path ) { 42 try { 43 return readdirSync( path ); 44 } catch ( err ) { 45 return err; 46 } 47 } 48 49 50 // EXPORTS // 51 52 module.exports = readDirSync;