diff --git a/doc/api/fs.md b/doc/api/fs.md index 3cb91e24b7124b..7b069599bb0671 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -892,6 +892,37 @@ fs.mkdtemp('/tmp/foo-', (err, folder) => { }); ``` +*Note*: The `fs.mkdtemp()` method will append the six randomly selected +characters directly to the `prefix` string. For instance, given a directory +`/tmp`, if the intention is to create a temporary directory *within* `/tmp`, +the `prefix` *must* end with a trailing platform-specific path separator +(`require('path').sep`). + +```js +// The parent directory for the new temporary directory +const tmpDir = '/tmp'; + +// This method is *INCORRECT*: +fs.mkdtemp(tmpDir, (err, folder) => { + if (err) throw err; + console.log(folder); + // Will print something similar to `/tmp-abc123`. + // Note that a new temporary directory is created + // at the file system root rather than *within* + // the /tmp directory. +}); + +// This method is *CORRECT*: +const path = require('path'); +fs.mkdtemp(tmpDir + path.sep, (err, folder) => { + if (err) throw err; + console.log(folder); + // Will print something similar to `/tmp/abc123`. + // A new temporary directory is created within + // the /tmp directory. +}); +``` + ## fs.mkdtempSync(template)