https://github.com/b4dnewz/node-temp
A node utility to handle temporary files and folders
https://github.com/b4dnewz/node-temp
buffer mock random temporary temporary-directory temporary-files testing testing-tools testing-utilities testing-utils
Last synced: 20 days ago
JSON representation
A node utility to handle temporary files and folders
- Host: GitHub
- URL: https://github.com/b4dnewz/node-temp
- Owner: b4dnewz
- License: other
- Created: 2019-10-28T01:07:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-09T23:29:13.000Z (almost 6 years ago)
- Last Synced: 2025-10-13T09:17:18.136Z (9 months ago)
- Topics: buffer, mock, random, temporary, temporary-directory, temporary-files, testing, testing-tools, testing-utilities, testing-utils
- Language: TypeScript
- Homepage: https://b4dnewz.github.io/node-temp/
- Size: 656 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# temp
> A node utility to handle temporary files and folders
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage percentage][coveralls-image]][coveralls-url]
---
## Getting started
Install the project using your favourite package manager.
```
npm install @b4dnewz/temp
```
Load inside your project all together or separate functions.
```typescript
import * as temp from "@b4dnewz/temp";
// or
import {file, fileSync, dir, dirSync} from "@b4dnewz/temp";
```
Then create any temporary file you need in your application or your tests.
```typescript
// create a temporary file
// es: /tmp/e6ba9fff240bde04897f/5fb6aa4e9ac8ccf10e2f
temp.file()
// create a temporary file in sync way
temp.fileSync()
// create a temporary directory
// es: /tmp/3c34454971179fc20e99/29d72d3cb2386b904afe
temp.dir()
// create a temporary directory in sync way
temp.dirSync()
```
```typescript
it("should create a temporary file", async () => {
const tmpFile = await temp.file()
// do whatever you need with the file
await tmpFile.remove()
})
```
Later on, when you have done with it, just release it.
```typescript
// will remove the temporary file
tmpFile.remove()
// will remove the temporary directory
// even if has content in it
// such as other temporary files
tmpDir.remove()
```
## Documentation
This project provide an [online documentation](https://b4dnewz.github.io/node-temp/) automatically generated with [TypeDoc](), but a very deep documentation with __real world usage examples__ is coming soon, stay tuned.
---
## Contributing
1. Create an issue and describe your idea
2. Fork the project (https://github.com/b4dnewz/node-temp/fork)
3. Create your __feature branch__ (`git checkout -b my-new-feature`)
4. Commit your changes with logic (`git commit -am 'Add some feature'`)
5. Publish the branch (`git push origin my-new-feature`)
6. Add __some test__ for your new feature
7. Create a new Pull Request
---
## License
[MIT](./LICENSE) © [Filippo Conti](https://b4dnewz.github.io/)
[npm-image]: https://badge.fury.io/js/%40b4dnewz%2Ftemp.svg
[npm-url]: https://npmjs.org/package/@b4dnewz/temp
[travis-image]: https://travis-ci.org/b4dnewz/node-temp.svg?branch=master
[travis-url]: https://travis-ci.org/b4dnewz/node-temp
[coveralls-image]: https://coveralls.io/repos/b4dnewz/node-temp/badge.svg
[coveralls-url]: https://coveralls.io/r/b4dnewz/node-temp