time-to-botec/squiggle/node_modules/@stdlib/fs/resolve-parent-path/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

59 lines
1.2 KiB
Plaintext

{{alias}}( path[, options], clbk )
Asynchronously resolves a path by walking parent directories.
If unable to resolve a path, the function returns `null` as the path result.
Parameters
----------
path: string
Path to resolve.
options: Object (optional)
Options.
options.dir: string (optional)
Base directory from which to search. Default: current working directory.
clbk: Function
Callback to invoke after resolving a path.
Examples
--------
> function onPath( error, path ) {
... if ( error ) {
... console.error( error.message );
... } else {
... console.log( path );
... }
... };
> {{alias}}( 'package.json', onPath );
{{alias}}.sync( path[, options] )
Synchronously resolves a path by walking parent directories.
Parameters
----------
path: string
Path to resolve.
options: Object (optional)
Options.
options.dir: string (optional)
Base directory from which to search. Default: current working directory.
Returns
-------
out: string|null
Resolved path.
Examples
--------
> var out = {{alias}}.sync( 'package.json' );
See Also
--------