Package Exports
- json-front-matter
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (json-front-matter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
json-front-matter
Extract JSON front matter from strings and files
Installing
npm install json-front-matter
Methods
parse( s )Parses strings, returning an object with propertiesattributes, containing the JSON front matter, andbodycontaining the rest.parseFile( path, callback( err, data ))Parses file atpath, calling the callback upon completion withdataobject containingattribuetsandbody, like the string parse method.
Using
var fm = require('json-front-matter');
var string = '{{{ "title" : "some title", "array" : [ 1, 2, 3 ] }}} bodybodybody';
var out = fm.parse( string );
console.log( out.body ) // 'bodybodybody'
console.log( out.attributes.title ) // 'some title'
console.log( out.attributes.array ) // [ 1, 2, 3 ]Testing
Run node tests/runTests.js from project root -- testing uses nodeunit