time-to-botec/squiggle/node_modules/@stdlib/fs/read-dir/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

45 lines
854 B
Plaintext

{{alias}}( path, clbk )
Asynchronously reads the contents of a directory.
Parameters
----------
path: string|Buffer
Directory path.
clbk: Function
Callback to invoke after reading directory contents.
Examples
--------
> function onRead( error, data ) {
... if ( error ) {
... console.error( error.message );
... } else {
... console.log( data );
... }
... };
> {{alias}}( './beep/boop', onRead );
{{alias}}.sync( path )
Synchronously reads the contents of a directory.
Parameters
----------
path: string|Buffer
Directory path.
Returns
-------
out: Error|Array|Array<string>
Directory contents.
Examples
--------
> var out = {{alias}}.sync( './beep/boop' );
See Also
--------