daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add note about mkdtemp() platform differences 

PR-URL: https://github.com/nodejs/node/pull/26944
Fixes: https://github.com/nodejs/node/issues/26435
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
pull/26944/head
cjihrig 2019-03-27 10:38:57 -04:00
parent d8c2803dcf
commit dd9cad9cb3
No known key found for this signature in database
GPG Key ID: 7434390BDBE9B9C5
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/api/fs.md
View File

@ -2277,7 +2277,10 @@ changes:
Creates a unique temporary directory.
Generates six random characters to be appended behind a required
`prefix` to create a unique temporary directory.
`prefix` to create a unique temporary directory. Due to platform
inconsistencies, avoid trailing `X` characters in `prefix`. Some platforms,
notably the BSDs, can return more than six random characters, and replace
trailing `X` characters in `prefix` with random characters.
The created folder path is passed as a string to the callback's second
parameter.
@ -4280,7 +4283,10 @@ added: v10.0.0
Creates a unique temporary directory and resolves the `Promise` with the created
folder path. A unique directory name is generated by appending six random
characters to the end of the provided `prefix`.
characters to the end of the provided `prefix`. Due to platform
inconsistencies, avoid trailing `X` characters in `prefix`. Some platforms,
notably the BSDs, can return more than six random characters, and replace
trailing `X` characters in `prefix` with random characters.
The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use.