npmpackage.info

output-file-sync

Synchronously write a file and create its ancestor directories if needed

2.0.1

ISC

JavaScript

4.51 kB

393,481,959 1.7

Installations

npm install output-file-sync

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

9.5.0

NPM Version

5.6.0 Score

98.8

Supply Chain

98.9

Quality

75.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

1

Closed

1

Issues

Open

1

Total

2

Closed

1

Releases

v2.0.0

Published on 08 Mar 2017

View all 1 releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Developer

shinnn

Download Statistics

Total Downloads

393,481,959

Last Day

86,171

Last Week

366,851

Last Month

1,931,570

Last Year

30,247,780

GitHub Statistics

15 Stars

44 Commits

1 Forks

1 Watching

1 Branches

1 Contributors

Bundle Size

14.15 kB

Minified

4.51 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.0.1

Package Id

output-file-sync@2.0.1

Size

3.46 kB

NPM Version

5.6.0

Node Version

9.5.0

Publised On

15 Feb 2018

Total Downloads

Cumulative downloads

Total Downloads

393,481,959

Last day

1.3%

86,171

Compared to previous day

Last week

-16.1%

366,851

Compared to previous week

Last month

-1.2%

1,931,570

Compared to previous month

Last year

-4.4%

30,247,780

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

graceful-fs is-plain-obj mkdirp

Dev Dependencies

@shinnn/eslint-config-node eslint get-mode nyc read-utf8-file rmfr tape

Versions

output-file-sync

Synchronously write a file and create its ancestor directories if needed

1const {readFileSync} = require('fs');
2const outputFileSync = require('output-file-sync');
3
4outputFileSync('foo/bar/baz.txt', 'Hi!');
5readFileSync('foo/bar/baz.txt', 'utf8'); //=> 'Hi!'

Difference from fs.outputFileSync

This module is very similar to fs-extra's fs.outputFileSync method, but 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.

1const {statSync} = require('fs');
2const outputFileSync = require('output-file-sync');
3
4outputFileSync('foo/bar', 'content', {mode: 33260});
5statSync('foo').mode; //=> 33260

output-file-sync validates its arguments strictly, and prints highly informative error message.

Installation

Use npm.

npm install output-file-sync

API

1const outputFileSync = require('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.

1const {statSync} = require('fs');
2const outputFileSync = require('output-file-sync');
3
4// When the directory `foo/bar` exists
5outputFileSync('foo/bar/baz/qux.txt', 'Hello', 'utf-8');
6
7statSync('foo/bar/baz').isDirectory(); //=> true
8statSync('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.

1const dir = outputFileSync('foo/bar/baz.txt', 'Hello');
2dir === 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.

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

Related project

output-file (asynchronous version)

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to output-file-sync

sync-runner

1.0.0

To execute a binary executable file and return its standard output synchronization.

cy-i18n-sync-cli

1.0.3

sync-i8n [--way <tier|tile>] [--file-type <json|properties>] [--output src/locale] [--registry http://xxx]-p xxx

@puppedo/walk-sync

1.0.4

Synchronously walks through a directory and its subdirectories, returning an array of file paths.

fs-iconv

3.1.18

save file with charset/encoding/iconv