tmp-file

2.0.1 • Public • Published

tmp-file NPM version NPM monthly downloads npm total downloads

Create actual and temporary file on /tmp folder

code climate standard code style linux build status windows build status coverage status dependency status

You might also be interested in always-done.

Table of Contents

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install tmp-file --save

or install using yarn

$ yarn add tmp-file

Usage

For more use-cases see the tests

const tmpFile = require('tmp-file')

API

.generateFile

Generates a "file" object with path and contents properties without writing to disk. Where file.path will be random string to OS tmp folder, using tmp-filepath. And file.contents will be the passed contents or empty string.

Params

  • [contents] {String|Buffer}: completely optional, string or buffer passed to fs.writeFile
  • returns {Object}: plain file object

Example

const tmp = require('tmp-file')
 
const file = tmp.generateFile('foo bar contents')
 
console.log(file.path) // => '/tmp/cia0ervrm0000vppvw0t61v9m'
console.log(file.contents) // => 'foo bar contents'

.writeFile

Write a temporary file to disk on OS tmp folder. It generates a file object using .generateFile method which in turn uses tmp-filepath to generate random filepath to tmp folder.

Note: This function is exported as module.exports, exports.default and exports.writeFile. If you don't understand what we are talking about, just see the example below.

Params

  • [contents] {String|Buffer}: completely optional, string or buffer, passed to fs.writeFile
  • returns {Promise}: resolved promise with file object

Example

const tmpFile = require('tmp-file')
// or
// const tmpFile = require('tmp-file').default
// or
// const tmpFile = require('tmp-file').writeFile
 
tmpFile('quxie pixie').then((file) => {
  console.log(file.path) // => '/tmp/da4sd0e534d0vppvw0t61v9m'
  console.log(file.contents) // => 'quxie pixie'
})

Related

  • always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… more | homepage
  • minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
  • rolldown: Modern bundler built on rollup with support for presets and better configuration experience | homepage
  • rollup: Next-generation ES6 module bundler | homepage
  • tmp-filepath: Generate temporary filepath string (without writing to disk). Using scaleable, secure and fast cross-platform cuid package | homepage
  • try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions, using once and dezalgo libs. Useful for and… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

  1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
  2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
  3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
  4. Do NOT bump the version in package.json. For that we use npm run release, which is standard-version and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

License

Copyright © 2016-2017, Charlike Mike Reagent. Released under the MIT license.


This file was generated by verb-generate-readme, v0.2.3, on January 03, 2017.
Project scaffolded using charlike cli.

Package Sidebar

Install

npm i tmp-file

Weekly Downloads

35

Version

2.0.1

License

MIT

Last publish

Collaborators

  • vanchoy
  • tunnckocore