Skip to content

Commit

Permalink
doc: clarify fs.mkdtemp prefix argument
Browse files Browse the repository at this point in the history
Per: nodejs#6142

Clarify the prefix argument.

Fixes: nodejs#6142
  • Loading branch information
jasnell committed May 17, 2016
1 parent 78520fa commit 2aad164
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -728,6 +728,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 tmp_dir = '/tmp';

// This method is *INCORRECT*:
fs.mkdtemp(tmp_dir, (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(tmp_dir + 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)

The synchronous version of [`fs.mkdtemp()`][]. Returns the created
Expand Down

0 comments on commit 2aad164

Please sign in to comment.