Sign upLogin

tunnckoCore/tmp-file

View on GitHub
Star
README.md

Summary

Maintainability
Test Coverage
# tmp-file [![NPM version](https://img.shields.io/npm/v/tmp-file.svg?style=flat)](https://www.npmjs.com/package/tmp-file) [![NPM monthly downloads](https://img.shields.io/npm/dm/tmp-file.svg?style=flat)](https://npmjs.org/package/tmp-file) [![npm total downloads][downloads-img]][downloads-url]

> 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](https://github.com/hybridables/always-done#readme).

## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
  * [.generateFile](#generatefile)
  * [.writeFile](#writefile)
- [Related](#related)
- [Contributing](#contributing)
- [Building docs](#building-docs)
- [Running tests](#running-tests)
- [Author](#author)
- [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## Install
Install with [npm](https://www.npmjs.com/)

```
$ npm install tmp-file --save
```

or install using [yarn](https://yarnpkg.com)

```
$ yarn add tmp-file
```

## Usage
> For more use-cases see the [tests](test.js)

```js
const tmpFile = require('tmp-file')
```

## API

### [.generateFile](index.js#L38)
> 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**

```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'
```

### [.writeFile](index.js#L81)
> 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**

```js
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](https://www.npmjs.com/package/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](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme "Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more")
- [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme "Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.")
- [rolldown](https://www.npmjs.com/package/rolldown): Modern bundler built on [rollup][] with support for presets and better configuration experience | [homepage](https://github.com/rolldown/rolldown#readme "Modern bundler built on [rollup][] with support for presets and better configuration experience")
- [rollup](https://www.npmjs.com/package/rollup): Next-generation ES6 module bundler | [homepage](https://github.com/rollup/rollup "Next-generation ES6 module bundler")
- [tmp-filepath](https://www.npmjs.com/package/tmp-filepath): Generate temporary filepath string (without writing to disk). Using scaleable, secure and fast cross-platform [cuid][] package | [homepage](https://github.com/tunnckocore/tmp-filepath#readme "Generate temporary filepath string (without writing to disk). Using scaleable, secure and fast cross-platform [cuid][] package")
- [try-catch-core](https://www.npmjs.com/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](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme "Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.")

## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/tmp-file/issues/new).  
Please read the [contributing guidelines](CONTRIBUTING.md) 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](https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github) too.

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

1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section.
2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#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](.verb.md)._

## Running tests
Clone repository and run the following in that cloned directory

```
$ npm install && npm test
```

## Author
**Charlike Mike Reagent**

+ [github/tunnckoCore](https://github.com/tunnckoCore)
+ [twitter/tunnckoCore](http://twitter.com/tunnckoCore)
+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)

## License
Copyright © 2016-2017, [Charlike Mike Reagent](http://i.am.charlike.online). Released under the [MIT license](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/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