Create actual and temporary file on /tmp folder
npm install tmp-file> Create actual and temporary file on /tmp folder
[![code climate][codeclimate-img]][codeclimate-url]
[![standard code style][standard-img]][standard-url]
[![linux build status][travis-img]][travis-url]
[![windows build status][appveyor-img]][appveyor-url]
[![coverage status][coveralls-img]][coveralls-url]
[![dependency status][david-img]][david-url]
You might also be interested in always-done.
_(TOC generated by verb using markdown-toc)_
``
$ npm install tmp-file --save
or install using yarn
`
$ yarn add tmp-file
`js`
const tmpFile = require('tmp-file')
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
`js
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'
`$3
> Write a temporary file to disk on OS tmp folder. It generates a file object using 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
`js
const tmpFile = require('tmp-file')
// or
// const tmpFile = require('tmp-file').default
// or
// const tmpFile = require('tmp-file').writeFiletmpFile('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. Using scaleable, secure and fast cross-platform [cuid][] package")
- 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 | homepageContributing
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
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
+ github/tunnckoCore
+ twitter/tunnckoCore
+ codementor/tunnckoCore
*
_This file was generated by verb-generate-readme, v0.2.3, on January 03, 2017._
_Project scaffolded using [charlike][] cli._
[always-done]: https://github.com/hybridables/always-done
[async-done]: https://github.com/gulpjs/async-done
[base]: https://github.com/node-base/base
[charlike]: https://github.com/tunnckocore/charlike
[commitizen]: https://github.com/commitizen/cz-cli
[cuid]: https://github.com/ericelliott/cuid
[dezalgo]: https://github.com/npm/dezalgo
[once]: https://github.com/isaacs/once
[rollup]: https://github.com/rollup/rollup
[standard-version]: https://github.com/conventional-changelog/standard-version
[tmp-filepath]: https://github.com/tunnckocore/tmp-filepath
[verb-generate-readme]: https://github.com/verbose/verb-generate-readme
[verb]: https://github.com/verbose/verb
[downloads-url]: https://www.npmjs.com/package/tmp-file
[downloads-img]: https://img.shields.io/npm/dt/tmp-file.svg
[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/tmp-file
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/tmp-file.svg
[travis-url]: https://travis-ci.org/tunnckoCore/tmp-file
[travis-img]: https://img.shields.io/travis/tunnckoCore/tmp-file/master.svg?label=linux
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/tmp-file
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/tmp-file/master.svg?label=windows
[coveralls-url]: https://coveralls.io/r/tunnckoCore/tmp-file
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/tmp-file.svg
[david-url]: https://david-dm.org/tunnckoCore/tmp-file
[david-img]: https://img.shields.io/david/tunnckoCore/tmp-file.svg
[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg