Logo for jsDocs.io

mktemp

  • Version 2.0.1
  • Published
  • 58.5 kB
  • No dependencies
  • MIT license

Install

npm i mktemp
yarn add mktemp
pnpm add mktemp

Overview

create temporary files and directories

Index

Functions

Functions

function createDir

createDir: {
    (template: string): Promise<string | null>;
    (template: string, mode: fs.Mode): Promise<string>;
    (template: string, callback: Callback): void;
    (template: string, mode: fs.Mode, callback: Callback): void;
};

  • create unique name directory

    Parameter template

    template string for dirname

    Returns

    result with Promise

  • create unique name directory

    Parameter template

    template string for dirname

    Parameter mode

    permission

    Returns

    result with Promise

  • create unique name directory

    Parameter template

    template string for dirname

    Parameter callback

    callback function

  • create unique name directory

    Parameter template

    template string for dirname

    Parameter mode

    permission

    Parameter callback

    callback function

function createDirSync

createDirSync: {
    (template: string): string;
    (template: string, mode: fs.Mode): string;
};

  • create unique name directory, sync version

    Parameter template

    template string for dirname

    Returns

    unique filename

function createFile

createFile: {
    (template: string): Promise<string | null>;
    (template: string, mode: fs.Mode): Promise<string>;
    (template: string, callback: Callback): void;
    (template: string, mode: fs.Mode, callback: Callback): void;
};

  • create unique name file

    Parameter template

    template string for filename

    Returns

    result with Promise

  • create unique name file

    Parameter template

    template string for filename

    Parameter mode

    permission

    Returns

    result with Promise

  • create unique name file

    Parameter template

    template string for filename

    Parameter callback

    callback function

  • create unique name file

    Parameter template

    template string for filename

    Parameter mode

    permission

    Parameter callback

    callback function

function createFileSync

createFileSync: {
    (template: string): string;
    (template: string, mode: fs.Mode): string;
};

  • create unique name file, sync version

    Parameter template

    template string for filename

    Returns

    unique filename

  • create unique name file, sync version

    Parameter template

    template string for filename

    Parameter mode

    permission

    Returns

    unique filename

function generateUniqueName

generateUniqueName: (template: string) => string;

  • generate unique name

    Parameter template

    template string

    Returns

    unique name string

    Throws

    TypeError if template is not a string

Package Files (3)

Dependencies (0)

No dependencies.

Dev Dependencies (15)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/mktemp.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/mktemp)
  • HTML
    <a href="https://www.jsdocs.io/package/mktemp"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>