function mkdtempSync

Overload 1

#mkdtempSync(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 #

#prefix: string

#options: EncodingOption

optional

Return Type #

string

Overload 2

#mkdtempSync(prefix: string,
options: BufferEncodingOption,
): 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 #

#prefix: string

#options: BufferEncodingOption

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

Return Type #

Buffer

Overload 3

#mkdtempSync(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 #

#prefix: string

#options: EncodingOption

optional

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

Return Type #

string | Buffer