Create actual and temporary file on disk - support stream, sync, gulp, vinyl and async. Returns partially Record/Vinyl File Object
MIT License
Create actual and temporary file on /tmp folder
You might also be interested in always-done.
(TOC generated by verb using markdown-toc)
Install with npm
$ npm install tmp-file --save
or install using yarn
$ yarn add tmp-file
For more use-cases see the tests
const tmpFile = require('tmp-file')
Generates a "file" object with
path
andcontents
properties without writing to disk. Wherefile.path
will be random string to OS tmp folder, using tmp-filepath. Andfile.contents
will be the passedcontents
or empty string.
Params
[contents]
{String|Buffer}: completely optional, string or buffer passed to fs.writeFile
returns
{Object}: plain file objectExample
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'
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 objectExample
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'
})
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
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.npm run release
, which is standard-version and follows Conventional Changelog idealogy.Thanks a lot! :)
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.
Clone repository and run the following in that cloned directory
$ npm install && npm test
Charlike Mike Reagent
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.