output-file-sync

Synchronously write a file and create its ancestor directories if needed

var fs = require('fs');
var outputFileSync = require('output-file-sync');

outputFileSync('foo/bar/baz.txt', 'Hi!');
fs.readFileSync('foo/bar/baz.txt').toString(); //=> 'Hi!'

Difference from fs.outputFileSync

This module is very similar to fs-extra's fs.outputFileSync but they are different in the following points:

output-file-sync returns the path of the directory created first. See the API document for more details.

output-file-sync accepts mkdirp options.

var fs = require('fs');
var outputFileSync = require('output-file-sync');
outputFileSync('foo/bar', 'content', {mode: 33260});

fs.statSync('foo').mode; //=> 33260

Installation

Use npm.

npm install output-file-sync

API

var outputFileSync = require('output-file-sync');

outputFileSync(path, data [, options])

path: String
data: String or Buffer
options: Object or String (options for fs.writeFile and mkdirp)
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.

var fs = require('fs');
var outputFileSync = require('output-file-sync');

// When the directory `foo/bar` exists
outputFileSync('foo/bar/baz/qux.txt', 'Hello', 'utf-8');

fs.statSync('foo/bar/baz').isDirectory(); //=> true
fs.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.

var dir = outputFileSync('foo/bar/baz.txt', 'Hello');
dir; //=> Same value as `path.resolve('foo')`

options

All options for fs.writeFile and mkdirp are available.

Additionally, you can use fileMode option and dirMode option to set different permission between the file and directories.

options.fileMode

Set modes of a file, overriding mode option.

options.dirMode

Set modes of a directories, overriding mode option.

outputFileSync('dir/file', 'content', {dirMode: '0745', fileMode: '0644'});
fs.statSync('dir').mode.toString(8); //=> '40745'
fs.statSync('dir/file').mode.toString(8); //=> '100644'

Related project

output-file (asynchronous version)

License

Licensed under the MIT License.

README.md 3.9 KB Permalink History Raw