parser front matter
1.0.0
Промежуточное программное обеспечение Front Matter на основе серых веществ.
Установите с помощью NPM:
$ npm install --save parser-front-matterЭто похоже на двигатель Consolidate.js, но для анализа. Работает с сборкой, глаголом, генерирует, обновляется, Express.js, синтаксическим диапазоном или любым приложением с аналогичными соглашениями.
var parser = require ( 'parser-front-matter' ) ; Расположение переднего вопроса от данной строки или contents в данном file и обратный вызов next(err, file) .
Если объект передается, может использоваться file.content file.contents
Параметры
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
Параметры
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 генерируется глаголом, пожалуйста, не редактируйте Readme напрямую. Любые изменения в Readme должны быть внесены в шаблон.
Чтобы сгенерировать readme, запустите следующую команду:
$ npm install -g verbose/verb#dev verb-generate-readme && verbЗапуск и рецензирование модульных тестов - отличный способ познакомиться с библиотекой и ее API. Вы можете установить зависимости и запускать тесты со следующей командой:
$ npm install && npm testДжон Шлинкерт
Copyright © 2017, Джон Шлинкерт. Выпущено по лицензии MIT.
Этот файл был сгенерирован 16 июля 2017 года.
