Skip to main content

mkdtempSync

function mkdtempSync
Jump to headingmkdtempSync(
prefix: string,
options?: EncodingOption,
): string

Returns the created directory path.

For detailed information, see the documentation of the asynchronous version of this API: mkdtemp.

The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use.

Parameters Jump to heading

Jump to headingprefix: string

Return Type Jump to heading

string
Jump to headingmkdtempSync(
prefix: string,
): Buffer

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

Parameters Jump to heading

Jump to headingprefix: string

The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

Return Type Jump to heading

Buffer
Jump to headingmkdtempSync(
prefix: string,
options?: EncodingOption,
): string | Buffer

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

Parameters Jump to heading

Jump to headingprefix: string

The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

Return Type Jump to heading

string | Buffer
Back to top