diff --git a/lib/node_modules/@stdlib/fs/read-dir/README.md b/lib/node_modules/@stdlib/fs/read-dir/README.md index 30b3f34be611..5d8e23354c48 100644 --- a/lib/node_modules/@stdlib/fs/read-dir/README.md +++ b/lib/node_modules/@stdlib/fs/read-dir/README.md @@ -52,8 +52,10 @@ function onRead( error, data ) { Synchronously reads the contents of a directory. ```javascript +var isError = require( '@stdlib/assert/is-error' ); + var out = readDir.sync( __dirname ); -if ( out instanceof Error ) { +if ( isError( out ) ) { throw out; } console.log( out ); @@ -70,6 +72,8 @@ console.log( out ); - The difference between this module and [`fs.readdirSync()`][fs] is that [`fs.readdirSync()`][fs] will throw if an `error` is encountered (e.g., if given a non-existent `path`) and this module will return an `error`. Hence, the following anti-pattern + + ```javascript var fs = require( 'fs' ); @@ -81,16 +85,19 @@ console.log( out ); } ``` + + can be replaced by an approach which addresses existence via `error` handling. ```javascript + var isError = require( '@stdlib/assert/is-error' ); var readDir = require( '@stdlib/fs/read-dir' ); var dir = '/path/to/dir'; // Explicitly handle the error... dir = readDir.sync( dir ); - if ( dir instanceof Error ) { + if ( isError( dir ) ) { // You choose what to do... throw dir; } @@ -107,6 +114,7 @@ console.log( out ); ```javascript +var isError = require( '@stdlib/assert/is-error' ); var readDir = require( '@stdlib/fs/read-dir' ); /* Sync */ @@ -114,13 +122,13 @@ var readDir = require( '@stdlib/fs/read-dir' ); var out = readDir.sync( __dirname ); // returns -console.log( out instanceof Error ); +console.log( isError( out ) ); // => false out = readDir.sync( 'beepboop' ); // returns -console.log( out instanceof Error ); +console.log( isError( out ) ); // => true /* Async */ diff --git a/lib/node_modules/@stdlib/fs/read-dir/examples/index.js b/lib/node_modules/@stdlib/fs/read-dir/examples/index.js index 244a18f2d158..1c41291ce3f8 100644 --- a/lib/node_modules/@stdlib/fs/read-dir/examples/index.js +++ b/lib/node_modules/@stdlib/fs/read-dir/examples/index.js @@ -18,6 +18,7 @@ 'use strict'; +var isError = require( '@stdlib/assert/is-error' ); var readDir = require( './../lib' ); /* Sync */ @@ -25,13 +26,13 @@ var readDir = require( './../lib' ); var out = readDir.sync( __dirname ); // returns -console.log( out instanceof Error ); +console.log( isError( out ) ); // => false out = readDir.sync( 'beepboop' ); // returns -console.log( out instanceof Error ); +console.log( isError( out ) ); // => true /* Async */