33 lines
673 B
Markdown
33 lines
673 B
Markdown
|
[](https://circleci.com/gh/segmentio/read-metadata)
|
||
|
|
|
||
|
|
# read-metadata
|
||
|
|
|
||
|
|
Load a JSON or YAML metadata file and return it as an object.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```
|
||
|
|
npm install read-metadata
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
It handles both JSON and YAML and will return a parsed object.
|
||
|
|
|
||
|
|
```
|
||
|
|
var read = require('read-metadata');
|
||
|
|
|
||
|
|
read('path/to/metadata.json', function(err, data){
|
||
|
|
console.log(data);
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### read(path, callback)
|
||
|
|
|
||
|
|
Takes a path to the metadata file. The callback will be called with `fn(err, result)`.
|
||
|
|
|
||
|
|
### read.sync(path)
|
||
|
|
|
||
|
|
Load a metafile syncronously.
|