Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 1.57 KB

.verb.md

File metadata and controls

63 lines (38 loc) · 1.57 KB

Usage

const write = require('write');

Options

The following options may be used with any method.

options.newline

Type: boolean

Default: undefined

Ensure that contents has a trailing newline before writing it to the file system.

write.sync('foo.txt', 'some data...', { newline: true }); 

options.overwrite

Type: boolean

Default: undefined

Set to false to prevent existing files from being overwritten. See increment for a less severe alternative.

write.sync('foo.txt', 'some data...', { overwrite: false });

options.increment

Type: boolean

Default: undefined

Set to true to automatically rename files by appending an increment, like foo (2).txt, to prevent foo.txt from being overwritten. This is useful when writing log files, or other information where the file name is less important than the contents being written.

write.sync('foo.txt', 'some data...', { increment: true });
// if "foo.txt" exists, the file will be renamed to "foo (2).txt"

API

{%= apidocs("index.js") %}

Release history

See [CHANGELOG.md].