Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinnn/output-file-sync
Synchronously write a file and create its ancestor directories if needed
https://github.com/shinnn/output-file-sync
ancestor-directories filesystem javascript mkdirp modular nodejs synchronous writefilesync
Last synced: 26 days ago
JSON representation
Synchronously write a file and create its ancestor directories if needed
- Host: GitHub
- URL: https://github.com/shinnn/output-file-sync
- Owner: shinnn
- License: isc
- Created: 2014-11-13T08:00:53.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-05-26T23:12:59.000Z (over 5 years ago)
- Last Synced: 2024-09-18T01:57:26.541Z (about 2 months ago)
- Topics: ancestor-directories, filesystem, javascript, mkdirp, modular, nodejs, synchronous, writefilesync
- Language: JavaScript
- Size: 45.9 KB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# output-file-sync
[](https://www.npmjs.com/package/output-file-sync)
[](https://travis-ci.com/shinnn/output-file-sync)
[](https://coveralls.io/github/shinnn/output-file-sync?branch=master)
Synchronously write a file and create its ancestor directories if needed
```javascript
import {readFileSync} from 'fs';
import outputFileSync from 'output-file-sync';
outputFileSync('foo/bar/baz.txt', 'Hi!');
readFileSync('foo/bar/baz.txt', 'utf8'); //=> 'Hi!'
```
## Difference from [fs.outputFileSync](https://github.com/jprichardson/node-fs-extra/blob/master/docs/outputFile.md)
This module is very similar to [fs-extra](https://github.com/jprichardson/node-fs-extra)'s `fs.outputFileSync` method, but different in the following points:
1. *output-file-sync* returns the path of the directory created first. [See the API document for more details.](#outputfilesyncpath-data--options)
2. *output-file-sync* accepts [mkdirp] options.
```javascript
import {statSync} from 'fs';
import outputFileSync from 'output-file-sync';
outputFileSync('foo/bar', 'content', {mode: 33260});
statSync('foo').mode; //=> 33260
```
3. *output-file-sync* validates its arguments strictly, and prints highly informative error message.
## Installation
[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).
```
npm install output-file-sync
```
## API
```javascript
import outputFileSync from 'output-file-sync';
```
### outputFileSync(*path*, *data* [, *options*])
*path*: `string`
*data*: `string`, `Buffer` or `Uint8Array`
*options*: `Object` (options for [fs.writeFileSync] and [mkdirp]) or `string` (encoding)
Return: `string` if it creates more than one directories, otherwise `null`
It writes the data to a file synchronously. If ancestor directories of the file don't exist, it creates the directories before writing the file.
```javascript
import {statSync} from 'fs';
import outputFileSync from 'output-file-sync';
// When the directory `foo/bar` exists
outputFileSync('foo/bar/baz/qux.txt', 'Hello', 'utf-8');
statSync('foo/bar/baz').isDirectory(); //=> true
statSync('foo/bar/baz/qux.txt').isFile(); //=> true
```
It returns the directory path just like [mkdirp.sync](https://github.com/substack/node-mkdirp#mkdirpsyncdir-opts) does:
> Returns the first directory that had to be created, if any.
```javascript
const dir = outputFileSync('foo/bar/baz.txt', 'Hello');
dir === path.resolve('foo'); //=> true
```
#### options
All options for [fs.writeFileSync] and [mkdirp] are available.
Additionally, you can pass [`fileMode`](#optionsfilemode) and [`dirMode`](#optionsdirmode) options to set different permission between the file and directories.
##### options.fileMode
Set the mode of a file, overriding `mode` option.
##### options.dirMode
Set the modes of directories, overriding `mode` option.
```javascript
outputFileSync('dir/file', 'content', {dirMode: '0745', fileMode: '0644'});
fs.statSync('dir').mode.toString(8); //=> '40745'
fs.statSync('dir/file').mode.toString(8); //=> '100644'
```
## Related
* [output-file](https://github.com/shinnn/output-file) – asynchronous version
## License
[ISC License](./LICENSE) © 2017 - 2019 Watanabe Shinnosuke
[fs.writeFileSync]: https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options
[mkdirp]: https://github.com/substack/node-mkdirp