Synchronously write a file and create its ancestor directories if needed
npm install output-file-sync
Synchronously write a file and create its ancestor directories if needed
``javascript
const {readFileSync} = require('fs');
const outputFileSync = require('output-file-sync');
outputFileSync('foo/bar/baz.txt', 'Hi!');
readFileSync('foo/bar/baz.txt', 'utf8'); //=> 'Hi!'
`
This module is very similar to 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.
2. output-file-sync accepts [mkdirp] options.
`javascript
const {statSync} = require('fs');
const outputFileSync = require('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.
`
npm install output-file-sync
`javascript`
const outputFileSync = require('output-file-sync');
path: string string
data: , Buffer or Uint8Array Object
options: (options for [fs.writeFileSync] and [mkdirp]) or string (encoding) string
Return: 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
const {statSync} = require('fs');
const outputFileSync = require('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:
> 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 and dirMode 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'
* output-file (asynchronous version)
ISC License © 2017 - 2018 Shinnosuke Watanabe
[fs.writeFileSync]: https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options
[mkdirp]: https://github.com/substack/node-mkdirp