灰色に基づいてミドルウェアを解析するフロントマター。
npmにインストール:
$ npm install --save parser-front-matter
これは、consolidate.jsエンジンに似ていますが、解析用です。アセンブル、動詞、生成、更新、Express.js、パーサーキャッシュ、または同様の規則のあるアプリケーションで動作します。
var parser = require ( 'parser-front-matter' ) ;
指定された文字列または指定された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'}}
} ) ;
指定された文字列または指定された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
:前面式の元のコンテンツ文字列が含まれていますリクエストと星を引き出すことはいつでも大歓迎です。バグと機能のリクエストについては、問題を作成してください。
コミット | 貢献者 |
---|---|
69 | Jonschlinkert |
2 | DOOWB |
(このプロジェクトのreadme.mdは動詞によって生成されます。readmeを直接編集しないでください。readmeの変更は.verb.md readmeテンプレートで行う必要があります。)
readmeを生成するには、次のコマンドを実行します。
$ npm install -g verbose/verb#dev verb-generate-readme && verb
ユニットテストの実行とレビューは、ライブラリとそのAPIに慣れるのに最適な方法です。次のコマンドで依存関係をインストールし、テストを実行できます。
$ npm install && npm test
ジョン・シュリンカート
Copyright©2017、Jon Schlinkert。 MITライセンスの下でリリースされました。
このファイルは、2017年7月16日に動詞generate-readme v0.6.0によって生成されました。