write

2019-01-13 admin

write是什么

什么是write,Write data to a file, replacing the file if it already exists and creating any intermediate directories if they don't already exist. Thin wrapper around node's native fs methods.

write使用教程帮助文档

write NPM version NPM monthly downloads NPM total downloads Linux Build Status

Write data to a file, replacing the file if it already exists and creating any intermediate directories if they don’t already exist. Thin wrapper around node’s native fs methods.

Install

Install with npm:

$ npm install --save write

Usage

var writeFile = require('write');

API

writeFile

Asynchronously writes data to a file, replacing the file if it already exists and creating any intermediate directories if they don’t already exist. Data can be a string or a buffer. Returns a promise if a callback function is not passed.

Params

  • filepath {string|Buffer|integer}: filepath or file descriptor.
  • data {string|Buffer|Uint8Array}: String to write to disk.
  • options {object}: Options to pass to fs.writeFile and/or mkdirp. Some extra options can also be passed (see below)
  • callback {Function}: (optional) If no callback is provided, a promise is returned.

Custom options:

In addition to fs.writeFile and mkdirp options, you can also pass some write specific options:

  • ensureNewLine: force a new line (\n) at the end of the file

Example

var writeFile = require('write');
writeFile('foo.txt', 'This is content...', function(err) {
  if (err) console.log(err);
});

// promise
writeFile('foo.txt', 'This is content...')
  .then(function() {
    // do stuff
  });

.promise

The promise version of writeFile. Returns a promise.

Params

  • filepath {string|Buffer|integer}: filepath or file descriptor.
  • val {string|Buffer|Uint8Array}: String or buffer to write to disk.
  • options {object}: Options to pass to fs.writeFile and/or mkdirp
  • returns {Promise}

Example

var writeFile = require('write');
writeFile.promise('foo.txt', 'This is content...')
  .then(function() {
    // do stuff
  });

.sync

The synchronous version of writeFile. Returns undefined.

Params

  • filepath {string|Buffer|integer}: filepath or file descriptor.
  • data {string|Buffer|Uint8Array}: String or buffer to write to disk.
  • options {object}: Options to pass to fs.writeFileSync and/or mkdirp
  • returns {undefined}

Example

var writeFile = require('write');
writeFile.sync('foo.txt', 'This is content...');

.stream

Uses fs.createWriteStream to write data to a file, replacing the file if it already exists and creating any intermediate directories if they don’t already exist. Data can be a string or a buffer. Returns a new WriteStream object.

Params

Example

var fs = require('fs');
var writeFile = require('write');
fs.createReadStream('README.md')
  .pipe(writeFile.stream('a/b/c/other-file.md'))
  .on('close', function() {
    // do stuff
  });

Release history

v1.0.2 - 2017-07-11

  • improved documentation

v1.0.0 - 2017-07-09

Added

  • promise support

Changed

  • The main export will now return a promise if no callback is passed

About

Related projects

  • delete: Delete files and folders and any intermediate directories if they exist (sync and async). | homepage
  • read-data: Read JSON or YAML files. | homepage
  • read-yaml: Very thin wrapper around js-yaml for directly reading in YAML files. | homepage
  • write-data: Write a YAML or JSON file to disk. Automatically detects the format to write based… more | homepage
  • write-json: Write a JSON file to disk, also creates intermediate directories in the destination path if… more | homepage
  • write-yaml: Write YAML. Converts JSON to YAML writes it to the specified file. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits Contributor
33 jonschlinkert
1 tunnckoCore

Building docs

(This project’s readme.md is generated by verb, please don’t edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on July 11, 2017.

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-50878.html

文章标题:write

相关文章
为什么把<脚本>标签时,写文档。write()?
GumboDane提出了一个问题:Why split the &lt;script&gt; tag when writing it with document.write()?,或许与您遇到的问题类似。 回答者Gumbobobince给出了...
2018-03-05
write-file-atomic
write-file-atomic是什么 什么是write-file-atomic,Write files in an atomic fashion w/configurable ownership write-file-atomic官网...
2018-09-07
fs-writefile-promise
fs-writefile-promise是什么 什么是fs-writefile-promise,Promise version of fs.writefile fs-writefile-promise官网:官网 fs-writefile-...
2018-10-06
write-json
write-json是什么 什么是write-json,Write a JSON file to disk, also creates intermediate directories in the destination path if ...
2018-10-06
async-writer
async-writer是什么 什么是async-writer,The async-writer module makes it possible to asynchronously write data to an output stre...
2018-11-08
Write objects into file with Node.js
sarahbkim提出了一个问题:Write objects into file with Node.js,或许与您遇到的问题类似。 回答者Jim Schubert给出了该问题的处理方式: obj is an array in your e...
2018-04-14
write-data
write-data是什么 什么是write-data,Write a YAML or JSON file to disk. Automatically detects the format to write based on extens...
2018-10-06
popsicle-rewrite
popsicle-rewrite是什么 什么是popsicle-rewrite,Popsicle plugin to transform URLs before performing requests popsicle-rewrite官网...
2018-10-25
JSHint: Overwrite single .jshintrc option for whole folder
Sascha Wolf提出了一个问题:JSHint: Overwrite single .jshintrc option for whole folder,或许与您遇到的问题类似。 回答者fernandopasik给出了该问题的处理方式: ...
2018-04-27
回到顶部