npmpackage.info

Gathering detailed insights and metrics for read-yaml

read-yaml

Very thin wrapper around js-yaml for directly reading in YAML files.

1.1.0

MIT

JavaScript

41.57 kB

12,713,840 3

Installations

npm install read-yaml

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=0.10.0

Node Version

7.7.3

NPM Version

4.1.2 Pull Requests

Open

1

Total

2

Closed

0

Merged

1

Issues

Open

0

Total

2

Closed

2

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 3 contributors

Languages

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

jonschlinkert

Download Statistics

Total Downloads

12,713,840

Last Day

2,248

Last Week

11,039

Last Month

51,305

Last Year

2,125,753

GitHub Statistics

27 Stars

29 Commits

11 Forks

4 Watching

1 Branches

3 Contributors

Bundle Size

171.42 kB

Minified

41.57 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.1.0

Package Id

read-yaml@1.1.0

Size

2.93 kB

NPM Version

4.1.2

Node Version

7.7.3

Publised On

02 Apr 2017

Total Downloads

Cumulative downloads

Total Downloads

12,713,840

Last day

0.6%

2,248

Compared to previous day

Last week

-14.9%

11,039

Compared to previous week

Last month

-4%

51,305

Compared to previous month

Last year

-64.7%

2,125,753

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

extend-shallow js-yaml

Dev Dependencies

gulp-format-md mocha should

Versions

read-yaml

Very thin wrapper around js-yaml for directly reading in YAML files.

Install

Install with npm:

1$ npm install --save read-yaml

API

readYaml

Read yaml file asynchronously and parse content as JSON.

Params

filepath {String}: Path of the file to read.
options {Object|String}: to pass to js-yaml
cb {Function}: Callback function `

Example

1var readYaml = require('read-yaml');
2readYaml('config.yml', function(err, data) {
3  if (err) throw err;
4  console.log(data);
5});

.sync

Read yaml file synchronously and parse content as JSON.

Params

filepath {String}: Path of the file to read.
options {Object|String}: to pass to js-yaml.
returns {Object}: JSON

Example

1var read = require('read-yaml');
2var config = read.sync('config.yml');

About

Related projects

copy: Copy files or directories using globs. | homepage
read-data: Read JSON or YAML files. | homepage
write: Write files to disk, creating intermediate directories if they don't exist. | homepage

Contributing

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

Contributors

Commits	Contributor
15	shinnn
10	jonschlinkert

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:

1$ 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:

1$ npm install && npm test

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.4.3, on April 02, 2017.

No vulnerabilities found.

10

Binary-Artifacts

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

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

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3

/10

Last Scanned on 2025-02-03

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

read-yaml

Installations

Developer Guide

No

CommonJS

>=0.10.0

7.7.3

4.1.2

Pull Requests

1

2

0

1

Issues

0

2

2

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

171.42 kB

41.57 kB

Maintainers

Package Meta Information

Total Downloads

12,713,840

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

read-yaml

Install

API

readYaml

.sync

About

Related projects

Contributing

Contributors

Building docs

Running tests

Author

License

10

10

10

0

0

0

0

0

0

0

3

/10