المادة الأمامية تحليل الوسيطة على أساس الرمادي.
التثبيت مع NPM:
$ npm install --save parser-front-matter
هذا مشابه لمحرك Consolidate.js ، ولكن لتحليل. يعمل مع Assemble أو Verb أو إنشاء أو تحديث أو Express.js أو محللي ذاكرة التخزين المؤقت أو أي تطبيق مع اتفاقيات مماثلة.
var parser = require ( 'parser-front-matter' ) ;
تحليل المادة الأمامية من السلسلة المحددة أو contents
الموجودة في file
المحدد والاستدعاء next(err, file)
.
إذا تم تمرير كائن file.content
file.contents
params
file
{String | Object} : الكائن أو السلسلة إلى تحليل.options
{كائن | وظيفة} : أو وظيفة رد الاتصال next
. يتم تمرير الخيارات إلى الرمادي.next
{function} : وظيفة رد الاتصال.مثال
// 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'}}
} ) ;
تحليل المادة الأمامية من السلسلة المحددة أو contents
في file
المحدد. إذا تم تمرير كائن file.content
file.contents
params
file
{String | Object} : الكائن أو السلسلة إلى تحليل.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 لهذا المشروع بواسطة Verb ، يرجى عدم تحرير README مباشرة. يجب إجراء أي تغييرات على ReadMe في قالب README.
لإنشاء README ، قم بتشغيل الأمر التالي:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
يعد تشغيل اختبارات الوحدة ومراجعتها طريقة رائعة للتعرف على مكتبة وواجهة برمجة التطبيقات الخاصة بها. يمكنك تثبيت التبعيات وتشغيل الاختبارات مع الأمر التالي:
$ npm install && npm test
جون شلينكرت
حقوق الطبع والنشر © 2017 ، جون شلينكرت. صدر تحت رخصة معهد ماساتشوستس للتكنولوجيا.
تم إنشاء هذا الملف بواسطة Verb-Generate-Readme ، v0.6.0 ، في 16 يوليو 2017.