time-to-botec/squiggle/node_modules/@stdlib/process/chdir/docs/repl.txt

26 lines
508 B
Plaintext
Raw Normal View History

{{alias}}( path )
Changes the current working directory.
If unable to set the current working directory (e.g., due to a non-existent
path), the function returns an error; otherwise, the function returns
`null`.
Parameters
----------
path: string
Desired working directory.
Returns
-------
err: Error|null
Error object or null.
Examples
--------
> var err = {{alias}}( '/path/to/current/working/directory' )
See Also
--------