전면 물질은 회색 단체를 기반으로 미들웨어를 구문 분석합니다.
NPM으로 설치 :
$ npm install --save parser-front-matter
이것은 consolidate.js 엔진과 유사하지만 구문 분석 용입니다. 조립, 동사, 생성, 업데이트, Express.js, Parser-Cache 또는 유사한 규칙이있는 응용 프로그램과 함께 작동합니다.
var parser = require ( 'parser-front-matter' ) ;
주어진 문자열 또는 주어진 file
의 contents
및 next(err, file)
내용을 구문 분석합니다.
객체가 전달되면 file.contents
또는 file.content
사용할 수 있습니다 (Gulp 및 조립 호환).
매개 변수
file
{문자열 | 개체} : 객체 또는 문자열을 구문 분석합니다.options
{object | function} : 또는 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'}}
} ) ;
주어진 문자열 또는 주어진 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
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. MIT 라이센스에 따라 릴리스.
이 파일은 2017 년 7 월 16 일에 동사 세대 판독 ME, v0.6.0에 의해 생성되었습니다.