File size: 2,806 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# mktemp
[](https://travis-ci.org/sasaplus1/mktemp)
[](https://gemnasium.com/sasaplus1/mktemp)
[](http://badge.fury.io/js/mktemp)
mktemp command for node.js
## Installation
```sh
$ npm install mktemp
```
## Usage
```js
var mktemp = require('mktemp');
mktemp.createFile('XXXXX.txt', function(err, path) {
if (err) throw err;
// path match a /^[\da-zA-Z]{5}\.txt$/
console.log(path);
});
// return value match a /^[\da-zA-Z]{5}\.tmp$/
mktemp.createFileSync('XXXXX.tmp');
mktemp.createDir('XXXXXXX', function(err, path) {
if (err) throw err;
// path match a /^[\da-zA-Z]{7}$/
console.log(path);
});
// return value match a /^XXX-[\da-zA-Z]{3}$/
mktemp.createDirSync('XXX-XXX');
```
if support Promise, can use Promise style.
```js
var mktemp = require('mktemp');
mktemp
.createFile('XXXXX.txt')
.then(function(path) {
// path match a /^[\da-zA-Z]{5}\.txt$/
console.log(path);
})
.catch(function(err) {
console.error(err);
});
mktemp
.createDir('XXXXX')
.then(function(path) {
// path match a /^[\da-zA-Z]{5}$/
console.log(path);
})
.catch(function(err) {
console.error(err);
});
```
mktemp functions are replace to random string from placeholder "X" in template. see example:
```js
mktemp.createFileSync('XXXXXXX'); // match a /^[\da-zA-Z]{7}$/
mktemp.createFileSync('XXX.tmp'); // match a /^[\da-zA-Z]{3}\.tmp$/
mktemp.createFileSync('XXX-XXX'); // match a /^XXX-[\da-zA-Z]{3}$/
```
## Functions
### createFile(template[, callback])
* `template`
* `String` - filename template
* `callback`
* `function(err, path)` - callback function
* `err` : `Error|Null` - error object
* `path` : `String` - path
create blank file of unique filename. permission is `0600`.
it throws TypeError if node.js unsupported Promise and callback is not a function.
### createFileSync(template)
* `template`
* `String` - filename template
* `return`
* `String` - path
sync version createFile.
### createDir(template[, callback])
* `template`
* `String` - dirname template
* `callback`
* `function(err, path)` - callback function
* `err` : `Error|Null` - error object
* `path` : `String` - path
create directory of unique dirname. permission is `0700`.
it throws TypeError if node.js unsupported Promise and callback is not a function.
### createDirSync(template)
* `template`
* `String` - dirname template
* `return`
* `String` - path
sync version createDir.
## Test
```sh
$ npm install
$ npm test
```
## Contributors
* [Michael Ficarra](https://github.com/michaelficarra)
## License
The MIT license. Please see LICENSE file.
|