parser front matter

解析器front-matter

前物质基于灰色 - 摩擦解析中间件。

安装

使用NPM安装：

$ npm install --save parser-front-matter

这类似于consolidate.js引擎，但用于解析。使用汇编，动词，生成，更新，Express.js，Parser-Cache或任何具有类似约定的应用程序。

用法

 var parser = require ( 'parser-front-matter' ) ; 

API

.parse

从给定的字符串或给定file中的contents和回调next(err, file)中解析前面物质。

如果传递对象，则可以使用file.contents或file.content （用于Gulp和组装兼容性）。

参数

• file {字符串|对象} ：解析的对象或字符串。
• options {对象|函数} ：或next回调函数。选项将传递给灰色 - 毛线。
• next {函数} ：回调函数。

例子

 // pass a string
parser . parse ( '---ntitle: foon---nbar' , function ( err , file ) {
  //=> {content: 'bar', data: {title: 'foo'}}
} ) ;

// or an object
var file = { contents : new Buffer ( '---ntitle: foonbar' ) } ;
parser . parse ( file , function ( err , res ) {
  //=> {content: 'bar', data: {title: 'foo'}}
} ) ;

.parsesync

从给定的字符串或给定file中的contents分析前提。如果传递对象，则可以使用file.contents或file.content （用于Gulp和组装兼容性）。

参数

• file {字符串|对象} ：解析的对象或字符串。
• options {object} ：传递给灰色 - 毛线。

例子

 // pass a string
var res = parser . parseSync ( '---ntitle: foon---nbar' ) ;

// or an object
var file = { contents : new Buffer ( '---ntitle: foonbar' ) } ;
var res = parser . parseSync ( file ) ;
//=> {content: 'bar', data: {title: 'foo'}} 

文件对象

返回的file对象具有以下属性（在给定文件上没有修改其他属性）：

• data ：分析前物质的数据
• content ：内容字符串，不包括前符号（组装兼容性）
• contents ：内容字符串作为缓冲区，不包括前框
• orig ：包含带有正面的原始内容字符串

关于

相关项目

• 灰色 - 摩尔：从字符串或文件中解析。快速，可靠且易于使用。解析yaml…更多|首页
• 解析器 - 缓存：缓存和加载解析器，与consolidate.js发动机相似。 |首页
• Parser-CSV：CSV解析器，与Parser-Cache兼容。 |首页

贡献

始终欢迎拉动请求和星星。对于错误和功能请求，请创建一个问题。

贡献者

提交	贡献者
69	Jonschlinkert
2	杜布

建筑文档

（该项目的readme.md是由动词生成的，请不要直接编辑读书文件。必须在.verb.md readme模板中对redme进行任何更改。）

要生成读数，请运行以下命令：

$ npm install -g verbose/verb#dev verb-generate-readme && verb

运行测试

运行和审查单元测试是熟悉库及其API的好方法。您可以使用以下命令安装依赖项并运行测试：

$ npm install && npm test

作者

乔恩·施林克特（Jon Schlinkert）

• github/jonschlinkert
• Twitter/Jonschlinkert

执照

版权所有©2017，Jon Schlinkert。根据MIT许可发布。

---

该文件是由动词生成雷德姆（V0.6.0）于2017年7月16日生成的。