Skip to content

Add the fs.mkdtemp() function. #5333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ralt wants to merge 3 commits into from
Closed

Add the fs.mkdtemp() function. #5333

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f40549
fs: add the fs.mkdtemp() function.
ralt Feb 24, 2016
2acd598
doc: add fs.mkdtemp() and fs.mkdtempSync()
ralt Feb 24, 2016
d56a3df
test: add fs.mkdtemp() and fs.mkdtempSync() tests
ralt Feb 24, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: add fs.mkdtemp() and fs.mkdtempSync()
  • Loading branch information
@ralt
ralt committed Mar 1, 2016
commit 2acd5984bbf19677dc17d413cd1e551fcaf381fa
24 changes: 24 additions & 0 deletions doc/api/fs.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,30 @@ to the completion callback. `mode` defaults to `0o777`.

Synchronous mkdir(2). Returns `undefined`.

## fs.mkdtemp(prefix, callback)

Creates a unique temporary directory.

Generates six random characters to be appended behind a required
`prefix` to create a unique temporary directory.

The created folder path is passed as a string to the callback's second
parameter.

Example:

```js
fs.mkdtemp('/tmp/foo-', (err, folder) => {
console.log(folder);
// Prints: /tmp/foo-itXde2
Copy link
Copy Markdown
Member

@bnoordhuis bnoordhuis Mar 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indent error. You could put it on the same line as the console.log.

Copy link
Copy Markdown
Contributor Author

@ralt ralt Mar 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See here as for why this indentation was chosen: #5333 (comment)

});
```

## fs.mkdtempSync(template)

The synchronous version of [`fs.mkdtemp()`][]. Returns the created
folder path.

Copy link
Copy Markdown
Member

@jasnell jasnell Feb 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer just duplicating the description of mkdtmp here rather than linking to it. Why make the user jump around?

Copy link
Copy Markdown
Contributor Author

@ralt ralt Feb 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because this is what every other sync function description does? I'm all for verboseness in documentation, but I'm even more in favor of consistency.

Copy link
Copy Markdown
Member

@jasnell jasnell Mar 7, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I've been slowly working towards adding the verboseness. This is fine for now. We can expand it out later.

## fs.open(path, flags[, mode], callback)

Asynchronous file open. See open(2). `flags` can be:
Expand Down