@coolgk/tmp

@coolgk/tmp

a javascript / typescript module
npm install @coolgk/tmp
wrapper functions, generate tmp file or folders
Report bugs here: https://github.com/coolgk/node-utils/issues

Examples

import { generateFile, generateDir, generateTmpName } from '@coolgk/tmp';
// OR
// const { generateFile, generateDir, generateTmpName } = require('@coolgk/tmp');

generateFile({dir: '/tmp/test'}).then((r) => console.log('file', r));
    // file { path: '/tmp/test/1512307052908140480ZZj6J0LOIJb.tmp' }

generateDir({dir: '/tmp/test'}).then((r) => console.log('dir',r));
    // dir { path: '/tmp/test/1512307052918140484Pnv1m95ZS2b' }

generateTmpName({dir: '/tmp/test'}).then((r) => console.log('name', r));
    // name { path: '/tmp/test/151230705292114048hb3XIds0FO9Y' }

Functions

generateFile(options) ⇒ promise

generateDir(options) ⇒ promise

generateTmpName(options) ⇒ promise

generateFile(options) ⇒ promise

Kind: global function
Returns: promise - - { path: ..., cleanupCallback: ... } calling cleanupCallback() removes the generated file
| Param | Type | Default | Description | | --- | --- | --- | --- | | options | object | | | | options.mode | number | 0600 | the file mode to create with, defaults to 0600 on file and 0700 on directory | | options.prefix | string | "Date.now()" | the optional prefix, fallbacks to tmp- if not provided | | options.postfix | string | "'.tmp'" | the optional postfix, fallbacks to .tmp on file creation | | options.dir | string | "/tmp" | the optional temporary directory, fallbacks to system default | | options.keep | boolean | false | if to keep the file |

generateDir(options) ⇒ promise

Kind: global function
Returns: promise - - { path: ..., cleanupCallback: ... } calling cleanupCallback() removes the generated file
| Param | Type | Default | Description | | --- | --- | --- | --- | | options | object | | | | options.mode | number | 0600 | the file mode to create with, defaults to 0600 on file and 0700 on directory | | options.prefix | string | "Date.now()" | the optional prefix, fallbacks to tmp- if not provided | | options.postfix | string | "'.tmp'" | the optional postfix, fallbacks to .tmp on file creation | | options.dir | string | "/tmp" | the optional temporary directory, fallbacks to system default | | options.keep | boolean | false | if to keep the file |

generateTmpName(options) ⇒ promise

Kind: global function
Returns: promise - - { path: ... }
| Param | Type | Default | Description | | --- | --- | --- | --- | | options | object | | | | options.mode | number | 0600 | the file mode to create with, defaults to 0600 on file and 0700 on directory | | options.prefix | string | "Date.now()" | the optional prefix, fallbacks to tmp- if not provided | | options.postfix | string | "'.tmp'" | the optional postfix, fallbacks to .tmp on file creation | | options.dir | string | "/tmp" | the optional temporary directory, fallbacks to system default |