temppath

Methods

(async, inner) createTempPath(tmpdiropt, optionsopt, callback)

Description:

• Asynchronously creates a temporary path, either as a directory or file, based on the provided or system temporary directory.

  This function utilizes the getTempPath function. To limit the characters' length of generated temporary directory or file name, set the options.maxLen to the desired value and it must be a positive number. Thus, the function will trim the name to the desired maximum length.

Source:

• index.js, line 177

Since:

• 0.2.0

Examples

Only specify a callback function

// Without any argument but a callback function
// This will create a temporary directory in system's temporary path
createTempPath(function (err, createdPath) {
  if (err) console.error(err);
  else console.log(createdPath);
  // Unix: "$TMPDIR/<TEMPPATH_DIR>"
  // Termux Android: "$TMPDIR/<TEMPPATH_DIR>" or "$PREFIX/tmp/<TEMPPATH_DIR>"
  // Windows: "%TMP%\<TEMPPATH_DIR>" or "%TEMP%\<TEMPPATH_DIR>"
});

Create a temporary file in system's temporary path

// This will create a temporary file in system's temporary path
// with extension name of '.foo_temp'
createTempPath({ asFile: true, ext: 'foo_temp' }, function (err, createdPath) {
  if (err) console.error(err);
  else console.log(createdPath);
  // Unix: "$TMPDIR/<TEMPPATH_FILE>.foo_temp"
  // Termux Android: "$TMPDIR/<TEMPPATH_FILE>.foo_temp" or "$PREFIX/tmp/<TEMPPATH_FILE>.foo_temp"
  // Windows: "%TMP%\<TEMPPATH_FILE>.foo_temp" or "%TEMP%\<TEMPPATH_FILE>.foo_temp"
});

Create a temporary file in current directory

const path = require('node:path');
// For ESM: import path from 'node:path';

// Use `process.cwd()` to get current directory path
createTempPath(path.join(process.cwd(), 'tmp'), { asFile: true }, function (err, createdPath) {
  if (err) console.error(err);
  else console.log(createdPath);
  // Unix: "$PWD/tmp/<TEMPPATH_FILE>.tmp"
  // Termux Android: "$PWD/tmp/<TEMPPATH_FILE>.tmp"
  // Windows: "%CD%\tmp\<TEMPPATH_FILE>.tmp"
});

Parameters:

Throws:

If the given arguments or the extension name specified with incorrect type.

Type

TypeError

(inner) createTempPathSync(tmpdiropt, optionsopt) → {string}

Description:

• Synchronously creates a temporary path, either as a directory or file, based on the provided or system temporary directory and then returns a path that refers to the generated temporary directory or file.

  This function utilizes the getTempPath function. To limit the characters' length of generated temporary directory or file name, set the options.maxLen to the desired value and it must be a positive number. Thus, the function will trim the name to the desired maximum length.

Source:

• index.js, line 301

Since:

• 0.2.0

Examples

Call the function without any argument

// If no argument specified, it will creates a temporary directory
// in system's temporary path
const tmpDirPath = createTempPathSync();
console.log(tmpDirPath);
// Unix: "$TMPDIR/<TEMPPATH_DIR>"
// Termux Android: "$TMPDIR/<TEMPPATH_DIR>" or "$PREFIX/tmp/<TEMPPATH_DIR>"
// Windows: "%TMP%\<TEMPPATH_DIR>" or "%TEMP%\<TEMPPATH_DIR>"

Create a temporary file with custom extension

const tmpFilePath = createTempPathSync({ asFile: true, ext: 'txt' });
console.log(tmpFilePath);
// Unix: "$TMPDIR/<TEMPPATH_FILE>.txt"
// Termux Android: "$TMPDIR/<TEMPPATH_FILE>.txt" or "$PREFIX/tmp/<TEMPPATH_FILE>.txt"
// Windows: "%TMP%\<TEMPPATH_FILE>.txt" or "%TEMP%\<TEMPPATH_FILE>.txt"

Create a temporary file in current directory

const path = require('node:path');
// For ESM: import path from 'node:path';

// Use `process.cwd()` to get current directory path
const customTmpFilePath = createTempPathSync(
  path.join(process.cwd(), 'tmp'), { asFile: true });
console.log(customTmpFilePath);
// Unix: "$PWD/tmp/<TEMPPATH_FILE>.tmp"
// Termux Android: "$PWD/tmp/<TEMPPATH_FILE>.tmp"
// Windows: "%CD%\tmp\<TEMPPATH_FILE>.tmp"

Parameters:

Throws:

• If the given arguments or the extension name specified with incorrect type.

  Type

  TypeError

• Throws an Error if there is an issue creating the temporary directory or file.

  Type

  Error

Returns:

Type

string

(inner) getTempPath(tmpdiropt, maxLenopt) → {string}

Description:

• Generates a temporary path based on the provided or system temporary directory.

  This function utilizes a random UUID for the directory name, ensuring that each time it is called, the path will be different from previous calls. The returned path can be used for either a temporary file or directory, according to user preferences.

  To limit the characters' length of generated temporary directory or file name, set the maxLen to the desired value and it must be a positive number. Thus, the function will trim the name to the desired maximum length.

Source:

• index.js, line 96

Since:

• 0.1.0

Parameters:

Throws:

• Throws a TypeError if the provided tmpdir is not a string.

  Type

  TypeError

• If the given maxLen is less than or equal to zero.

  Type

  RangeError

Returns:

Type

string