https://github.com/paranoidjk/egg-tmpfs
A plugin for egg which help to create and auto clean temp folder when request finish or error
https://github.com/paranoidjk/egg-tmpfs
egg egg-plugin eggjs fs nodejs
Last synced: about 1 year ago
JSON representation
A plugin for egg which help to create and auto clean temp folder when request finish or error
- Host: GitHub
- URL: https://github.com/paranoidjk/egg-tmpfs
- Owner: paranoidjk
- License: mit
- Created: 2018-08-29T06:32:49.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T01:48:38.000Z (over 1 year ago)
- Last Synced: 2025-03-27T15:13:52.222Z (over 1 year ago)
- Topics: egg, egg-plugin, eggjs, fs, nodejs
- Language: JavaScript
- Size: 24.4 KB
- Stars: 5
- Watchers: 0
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# egg-tmpfs
[](https://greenkeeper.io/)
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-tmpfs.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-tmpfs
[travis-image]: https://img.shields.io/travis/paranoidjk/egg-tmpfs.svg?style=flat-square
[travis-url]: https://travis-ci.org/paranoidjk/egg-tmpfs
[codecov-image]: https://img.shields.io/codecov/c/github/paranoidjk/egg-tmpfs.svg?style=flat-square
[codecov-url]: https://codecov.io/github/paranoidjk/egg-tmpfs?branch=master
[david-image]: https://img.shields.io/david/paranoidjk/egg-tmpfs.svg?style=flat-square
[david-url]: https://david-dm.org/paranoidjk/egg-tmpfs
[snyk-image]: https://snyk.io/test/npm/egg-tmpfs/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-tmpfs
[download-image]: https://img.shields.io/npm/dm/egg-tmpfs.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-tmpfs
## Install
```bash
$ npm i egg-tmpfs --save
```
## Usage
```js
// {app_root}/config/plugin.js
exports.tmpfs = {
enable: true,
package: 'egg-tmpfs',
};
```
## Configuration
```js
// {app_root}/config/config.default.js
exports.tmpfs = {
baseTmpPath: '/foo/bar',
};
```
see [config/config.default.js](config/config.default.js) for more detail.
## api
#### ctx.tmpfs.ensureDir(dir[,options][,callback])
same as [fsextra.ensureDir](https://github.com/jprichardson/node-fs-extra/blob/master/docs/ensureDir.md), but path will based on `config.tmpfs.baseTmpPath`, and the created folder will be auto cleand when request is finished or errored.
#### ctx.tmpfs.mark(path)
just incase you have to use original node fs module, then you can create file first, then mark it need to be delete.
#### ctx.tmpfs.unmark(path)
to revert what `ctx.tmpfs.mark(path)` did.
#### ctx.tmpfs.clean()
clean all tmp folders, return a Promise
> Generally, you do not need to use this :) egg-tmpfs will auto call clean.
## Example
see [test](/test/fixtures/apps/tmpfs-test/app/controller/home.js)
## Questions & Suggestions
Please open an issue [here](https://github.com/eggjs/egg/issues).
## License
[MIT](LICENSE)