doc: clarify fs.mkdtemp prefix argument
Per: https://github.com/nodejs/node/issues/6142 Clarify the prefix argument. Fixes: https://github.com/nodejs/node/issues/6142 PR-URL: https://github.com/nodejs/node/pull/6800 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
This commit is contained in:
parent
56ae651c80
commit
2ccba1f9fa
@ -900,6 +900,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)
|
## fs.mkdtempSync(template)
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
added: v5.10.0
|
added: v5.10.0
|
||||||
|
Loading…
x
Reference in New Issue
Block a user