blob: f5b9bc85ba1ccf5109e70c796629c97cb27f6c82 (
plain)
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
|
# write [](http://badge.fury.io/js/write) [](https://travis-ci.org/jonschlinkert/write)
> Write files to disk, creating intermediate directories if they don't exist.
Install with [npm](https://www.npmjs.com/)
```sh
$ npm i write --save
```
## API docs
### [writeFile](index.js#L32)
Asynchronously write a file to disk. Creates any intermediate directories if they don't already exist.
**Params**
* `dest` **{String}**: Destination file path
* `str` **{String}**: String to write to disk.
* `callback` **{Function}**
**Example**
```js
var writeFile = require('write');
writeFile('foo.txt', 'This is content to write.', function(err) {
if (err) console.log(err);
});
```
### [.writeFile.sync](index.js#L64)
Synchronously write files to disk. Creates any intermediate directories if they don't already exist.
**Params**
* `dest` **{String}**: Destination file path
* `str` **{String}**: String to write to disk.
**Example**
```js
var writeFile = require('write');
writeFile.sync('foo.txt', 'This is content to write.');
```
### [.writeFile.stream](index.js#L87)
Uses `fs.createWriteStream`, but also creates any intermediate directories if they don't already exist.
**Params**
* `dest` **{String}**: Destination file path
* `returns` **{Stream}**: Returns a write stream.
**Example**
```js
var write = require('write');
write.stream('foo.txt');
```
## Related
* [delete](https://github.com/jonschlinkert/delete): Delete files and folders and any intermediate directories if they exist (sync and async).
* [read-yaml](https://github.com/jonschlinkert/read-yaml): Very thin wrapper around js-yaml for directly reading in YAML files.
* [read-json](https://github.com/azer/read-json): Reads and parses a JSON file.
* [read-data](https://github.com/jonschlinkert/read-data): Read JSON or YAML files.
* [write-yaml](https://github.com/jonschlinkert/write-yaml): Write YAML. Converts JSON to YAML writes it to the specified file.
* [write-json](https://github.com/jonschlinkert/write-json): Write a JSON to file disk, also creates directories in the dest path if they… [more](https://github.com/jonschlinkert/write-json)
## Running tests
Install dev dependencies:
```sh
$ npm i -d && npm test
```
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/write/issues/new)
## Author
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2015 Jon Schlinkert
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on July 29, 2015._
<!-- deps:mocha -->
|
