Nevertheless! Party Metaphorically
    Wondering what’s next for npm?Check out our public roadmap! »

    write-data

    1.0.2 • Public • Published

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

    Write a YAML or JSON file to disk. Automatically detects the format to write based on extension. Or pass ext on the options.

    Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

    Install

    Install with npm:

    $ npm install --save write-data

    Usage

    Add to your node.js application with the following line of code:

    var writeData = require('write-data');
     
    // async
    writeData(filepath, data[, options], function(err) {
      // do stuff with "err"
    });
     
    // sync
    writeData.sync(filepath, data[, options]);

    API

    The file extension is used to detect the data format to write. This can be overriden by passing a value on options.ext.

    YAML examples

    var data = {language: 'node_js', node_js: ['0.10', '0.12']};
     
    // async
    writeData('.travis.yml', data, function(err) {
      // do stuff with "err"
    });
     
    // sync
    writeData.sync('.travis.yml', data);

    Both would write a .travis.yml file to disk with the following contents:

    language: node_js
    node_js:
      - "0.10"
      - "0.12"

    JSON examples

    var data = { name: 'foo', version: '0.1.0' };
     
    // async
    writeData('package.json', data, function(err) {
      // do stuff with "err"
    });
     
    // sync
    writeData.sync('package.json', data);

    Both would write a package.json file to disk with the following contents:

    { 
      "name": "foo", 
      "version": "0.1.0" 
    }

    About

    Contributing

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

    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
    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

    Related projects

    You might also be interested in these 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-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
    • write: Write data to a file, replacing the file if it already exists and creating any… more | homepage

    Author

    Jon Schlinkert

    License

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


    This file was generated by verb-generate-readme, v0.6.0, on January 26, 2018.

    Install

    npm i write-data

    DownloadsWeekly Downloads

    1,260

    Version

    1.0.2

    License

    MIT

    Last publish

    Collaborators

    • avatar