# fs-temp

> `fs-temp` is a quick and simple way to create temporary files and directories.

Latest version **2.0.1** (published 2021-11-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install fs-temp
pnpm add fs-temp
yarn add fs-temp
bun add fs-temp
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2021-11-02 |
| First published | 2014-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 |
| Dependencies | 1 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | linusu |

## Links

- npm: https://www.npmjs.com/package/fs-temp
- Repository: https://github.com/LinusU/fs-temp
- Homepage: https://github.com/LinusU/fs-temp#readme
- Issues: https://github.com/LinusU/fs-temp/issues
- npm.io page: https://npm.io/package/fs-temp

## Dependencies (1)

- [random-path](https://npm.io/package/random-path.md) ^1.0.0

## Recent versions

- 2.0.1 (latest) — 2021-11-02
- 2.0.0 — 2021-07-24
- 1.2.1 — 2020-05-28
- 1.2.0 — 2020-05-28
- 1.1.2 — 2016-11-02
- 1.1.1 — 2016-08-21
- 1.1.0 — 2016-05-17
- 1.0.0 — 2015-08-17
- 0.2.0 — 2015-08-17
- 0.1.3 — 2015-08-17
- 0.1.2 — 2015-03-02
- 0.1.1 — 2014-12-10
- 0.1.0 — 2014-09-19

## README

# fs-temp

`fs-temp` is a quick and simple way to create temporary files and directories.

Why another one? I know that there are already libraries doing similar things,
but I felt that their implementation was unnecessary complicated. I also wanted
a quick way to turn a buffer into a file.

## Installation

```sh
npm install --save fs-temp
```

## Usage

```js
import temp from 'fs-temp'

const data = Buffer.from('testing 1 2 3')
const path = temp.writeFileSync(data)

// `path` now holds the path to a file with the specified `data`
```

```js
import temp from 'fs-temp'

const path = temp.template('linusu-%s').mkdirSync()

// `path` now holds the path to a directory with the prefix 'linusu-'
```

## Promise support

If you import `fs-temp/promises` you'll receive an alternative API where all
functions that takes callbacks are replaced by `Promise`-returning functions.

```js
import temp from 'fs-temp/promises'

const data = Buffer.from('testing 1 2 3')
const path = await temp.writeFile(data)

// `path` now holds the path to a file with the specified `data`
```

## API

The api mimics the one provided by `fs` very closely.

### `open(flags[, mode], callback)`

Asynchronous file open.

`flags` is either `'w'` (only writing) or `'w+'` (writing and reading).

The callback gets two arguments `(err, obj)`. `obj` has `fd` and `path`.

### `openSync(flags[, mode])`

Synchronous version of `.open()`, returns `obj` with `fd` and `path`.

### `mkdir([mode, ]callback)`

Creates an empty directory.

The callback gets two arguments `(err, path)`.

### `mkdirSync([mode])`

Synchronous version of `.mkdir()`, returns `path`.

### `writeFile(data[, encoding], callback)`

Asynchronously writes data to a file. `data` can be a string or a buffer. The
`encoding` argument is ignored if `data` is a buffer. It defaults to `'utf8'`.

The callback gets two arguments `(err, path)`.

### `writeFileSync(data[, encoding])`

Synchronous version of `.writeFileSync()`, returns `path`.

### `createWriteStream([options])`

Creates and returns a `fs.WriteStream` that will write it's content to a
temporary file. This functions performs a little bit of blocking IO in order to
open the file initially.

### `template(template)`

Returns a copy of the module that uses the specified `template` when generating
file names. `template` should be a string where `%s` will be replaced with some
random characters (e.g. `'linusu-%s'`).

The string should contain `%s` exactly once. If you want to include a literal
percent sign, escape it with another one, e.g. `'%%string'` becomes `'%string'`.

## License

The MIT License (MIT)

Copyright (c) 2014 Linus Unnebäck

---
_Source: https://npm.io/package/fs-temp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._