{"_id":"read-yaml","_rev":"50114","name":"read-yaml","description":"Very thin wrapper around js-yaml for directly reading in YAML files.","dist-tags":{"latest":"1.1.0"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"time":{"modified":"2021-06-03T10:15:21.000Z","created":"2014-06-11T00:04:01.623Z","1.1.0":"2017-04-02T21:20:24.204Z","1.0.0":"2014-12-07T09:23:00.787Z","0.3.1":"2014-12-05T23:35:08.405Z","0.3.0":"2014-12-05T12:29:58.544Z","0.2.0":"2014-07-19T01:11:45.779Z","0.1.0":"2014-06-11T00:04:01.623Z"},"users":{"erincinci":true,"cknowles":true},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/read-yaml.git"},"versions":{"1.1.0":{"name":"read-yaml","description":"Very thin wrapper around js-yaml for directly reading in YAML files.","version":"1.1.0","homepage":"https://github.com/jonschlinkert/read-yaml","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"contributors":[{"name":"Jon Schlinkert","email":"jon.schlinkert@sellside.com","url":"http://twitter.com/jonschlinkert"},{"name":"Shinnosuke Watanabe","email":"snnskwtnb@gmail.com","url":"https://shinnn.github.io"}],"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/read-yaml.git"},"bugs":{"url":"https://github.com/jonschlinkert/read-yaml/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"extend-shallow":"^2.0.1","js-yaml":"^3.8.2"},"devDependencies":{"gulp-format-md":"^0.1.11","mocha":"^3.2.0","should":"^11.2.0"},"keywords":["async","data","file","fs","parse","read","sync","yaml","yml"],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"related":{"list":["copy","read-data","write"]},"lint":{"reflinks":true}},"gitHead":"5298d74ebac0949bd91f31f2ae84b0080637e91a","_id":"read-yaml@1.1.0","_shasum":"0d273ac0c95be92230dc0d4c4c4f5b8960a336d6","_from":".","_npmVersion":"4.1.2","_nodeVersion":"7.7.3","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"dist":{"shasum":"0d273ac0c95be92230dc0d4c4c4f5b8960a336d6","size":3002,"noattachment":false,"key":"/read-yaml/-/read-yaml-1.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-yaml/download/read-yaml-1.1.0.tgz"},"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/read-yaml-1.1.0.tgz_1491168023600_0.5856852936558425"},"directories":{},"publish_time":1491168024204,"_hasShrinkwrap":false,"_cnpm_publish_time":1491168024204},"1.0.0":{"name":"read-yaml","description":"Very thin wrapper around js-yaml for directly reading in YAML files.","version":"1.0.0","homepage":"https://github.com/jonschlinkert/read-yaml","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"repository":{"type":"git","url":"git://github.com/jonschlinkert/read-yaml.git"},"bugs":{"url":"https://github.com/jonschlinkert/read-yaml/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/read-yaml/blob/master/LICENSE-MIT"},"files":["index.js","LICENSE-MIT"],"engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"dependencies":{"js-yaml":"^3.2.3","xtend":"^4.0.0"},"devDependencies":{"mocha":"*","should":"^4.3.0"},"keywords":["async","data","file","fs","parse","read","sync","yaml","yml"],"gitHead":"512c41d9e61f53db496e0bdbb5ffac7e9c2f831d","_id":"read-yaml@1.0.0","_shasum":"ab529b12da653e03197079994d040131ba5f5765","_from":".","_npmVersion":"2.1.9","_nodeVersion":"0.10.33","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"dist":{"shasum":"ab529b12da653e03197079994d040131ba5f5765","size":2345,"noattachment":false,"key":"/read-yaml/-/read-yaml-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-yaml/download/read-yaml-1.0.0.tgz"},"directories":{},"publish_time":1417944180787,"_cnpm_publish_time":1417944180787,"_hasShrinkwrap":false},"0.3.1":{"name":"read-yaml","description":"Very thin wrapper around js-yaml for directly reading in YAML files.","version":"0.3.1","homepage":"https://github.com/jonschlinkert/read-yaml","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"repository":{"type":"git","url":"git://github.com/jonschlinkert/read-yaml.git"},"bugs":{"url":"https://github.com/jonschlinkert/read-yaml/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/read-yaml/blob/master/LICENSE-MIT"},"files":["index.js","LICENSE-MIT"],"engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"dependencies":{"js-yaml":"^3.2.3","xtend":"^4.0.0"},"devDependencies":{"mocha":"*","should":"^4.3.0"},"keywords":["async","data","file","fs","parse","read","sync","yaml","yml"],"gitHead":"667db4e7242fcc2e3a719c102dae7ec8a6c5160b","_id":"read-yaml@0.3.1","_shasum":"8f3c23be91169407810f6a3d73e763c6af50fa55","_from":".","_npmVersion":"2.1.9","_nodeVersion":"0.10.33","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"dist":{"shasum":"8f3c23be91169407810f6a3d73e763c6af50fa55","size":2344,"noattachment":false,"key":"/read-yaml/-/read-yaml-0.3.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-yaml/download/read-yaml-0.3.1.tgz"},"directories":{},"publish_time":1417822508405,"_cnpm_publish_time":1417822508405,"_hasShrinkwrap":false},"0.3.0":{"name":"read-yaml","description":"Very thin wrapper around js-yaml for directly reading in YAML files.","version":"0.3.0","homepage":"https://github.com/jonschlinkert/read-yaml","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"repository":{"type":"git","url":"git://github.com/jonschlinkert/read-yaml.git"},"bugs":{"url":"https://github.com/jonschlinkert/read-yaml/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/read-yaml/blob/master/LICENSE-MIT"},"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"dependencies":{"js-yaml":"^3.2.3","xtend":"^4.0.0"},"devDependencies":{"chai":"^1.10.0","mocha":"*","should":"^4.3.0"},"keywords":["async","data","file","fs","parse","read","sync","yaml"],"_id":"read-yaml@0.3.0","_shasum":"87f27af69615052a008e8b95c0e06fceb2ac740b","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"dist":{"shasum":"87f27af69615052a008e8b95c0e06fceb2ac740b","size":3636,"noattachment":false,"key":"/read-yaml/-/read-yaml-0.3.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-yaml/download/read-yaml-0.3.0.tgz"},"directories":{},"publish_time":1417782598544,"_cnpm_publish_time":1417782598544,"_hasShrinkwrap":false},"0.2.0":{"name":"read-yaml","description":"Very thin wrapper around js-yaml for directly reading in YAML files.","version":"0.2.0","homepage":"https://github.com/jonschlinkert/read-yaml","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/read-yaml.git"},"bugs":{"url":"https://github.com/jonschlinkert/read-yaml/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/read-yaml/blob/master/LICENSE-MIT"}],"keywords":["yaml","data","parse","read"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"chai":"~1.9.1","mocha":"*","verb":"~0.2.6","verb-tag-jscomments":"^0.1.2"},"dependencies":{"async":"^0.9.0","js-yaml":"^3.0.2"},"_id":"read-yaml@0.2.0","_shasum":"d3dce2a088a747eed8c5b7632ec6810ae881096b","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"dist":{"shasum":"d3dce2a088a747eed8c5b7632ec6810ae881096b","size":3313,"noattachment":false,"key":"/read-yaml/-/read-yaml-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-yaml/download/read-yaml-0.2.0.tgz"},"directories":{},"publish_time":1405732305779,"_cnpm_publish_time":1405732305779,"_hasShrinkwrap":false},"0.1.0":{"name":"read-yaml","description":"Very thin wrapper around js-yaml for directly reading in YAML files.","version":"0.1.0","homepage":"https://github.com/jonschlinkert/read-yaml","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/read-yaml.git"},"bugs":{"url":"https://github.com/jonschlinkert/read-yaml/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/read-yaml/blob/master/LICENSE-MIT"}],"keywords":["docs","documentation","generate","generator","markdown","templates","verb"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"chai":"~1.9.1","mocha":"*","verb":"~0.2.6","verb-tag-jscomments":"^0.1.2"},"dependencies":{"async":"^0.9.0","js-yaml":"^3.0.2","read-file":"^0.1.2"},"_id":"read-yaml@0.1.0","_shasum":"aeff080c003926d40e95b925539a5e5a32689465","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"},{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"dist":{"shasum":"aeff080c003926d40e95b925539a5e5a32689465","size":3246,"noattachment":false,"key":"/read-yaml/-/read-yaml-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-yaml/download/read-yaml-0.1.0.tgz"},"directories":{},"publish_time":1402445041623,"_cnpm_publish_time":1402445041623,"_hasShrinkwrap":false}},"readme":"# read-yaml [![NPM version](https://img.shields.io/npm/v/read-yaml.svg?style=flat)](https://www.npmjs.com/package/read-yaml) [![NPM monthly downloads](https://img.shields.io/npm/dm/read-yaml.svg?style=flat)](https://npmjs.org/package/read-yaml)  [![NPM total downloads](https://img.shields.io/npm/dt/read-yaml.svg?style=flat)](https://npmjs.org/package/read-yaml) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/read-yaml.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/read-yaml)\n\n> Very thin wrapper around js-yaml for directly reading in YAML files.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save read-yaml\n```\n\n## API\n\n### [readYaml](index.js#L29)\n\nRead yaml file asynchronously and parse content as JSON.\n\n**Params**\n\n* `filepath` **{String}**: Path of the file to read.\n* `options` **{Object|String}**: to pass to [js-yaml](https://github.com/nodeca/js-yaml)\n* `cb` **{Function}**: Callback function `\n\n**Example**\n\n```js\nvar readYaml = require('read-yaml');\nreadYaml('config.yml', function(err, data) {\n  if (err) throw err;\n  console.log(data);\n});\n```\n\n### [.sync](index.js#L69)\n\nRead yaml file synchronously and parse content as JSON.\n\n**Params**\n\n* `filepath` **{String}**: Path of the file to read.\n* `options` **{Object|String}**: to pass to [js-yaml](https://github.com/nodeca/js-yaml).\n* `returns` **{Object}**: JSON\n\n**Example**\n\n```js\nvar read = require('read-yaml');\nvar config = read.sync('config.yml');\n```\n\n## About\n\n### Related projects\n\n* [copy](https://www.npmjs.com/package/copy): Copy files or directories using globs. | [homepage](https://github.com/jonschlinkert/copy \"Copy files or directories using globs.\")\n* [read-data](https://www.npmjs.com/package/read-data): Read JSON or YAML files. | [homepage](https://github.com/jonschlinkert/read-data \"Read JSON or YAML files.\")\n* [write](https://www.npmjs.com/package/write): Write files to disk, creating intermediate directories if they don't exist. | [homepage](https://github.com/jonschlinkert/write \"Write files to disk, creating intermediate directories if they don't exist.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 15 | [shinnn](https://github.com/shinnn) |\n| 10 | [jonschlinkert](https://github.com/jonschlinkert) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning 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:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 02, 2017._","_attachments":{},"homepage":"https://github.com/jonschlinkert/read-yaml","bugs":{"url":"https://github.com/jonschlinkert/read-yaml/issues"},"license":"MIT"}