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日生成的。