Download parser front matter - parser front matter

parser front matter

Outras categorias

1.0.0

Baixar

Parser-Front-Matter

Front Matter Parsing Middleware com base no mato cinza.

Instalar

Instale com o NPM:

$ npm install --save parser-front-matter

Isso é semelhante a um mecanismo consolidado.js, mas para análise. Trabalha com montagem, verbo, gerar, atualizar, express.js, cache do analisador ou qualquer aplicativo com convenções semelhantes.

Uso

 var parser = require ( 'parser-front-matter' ) ;

API

.parse

Parse o assunto frontal da string fornecida ou do contents no file fornecido e no retorno de chamada next(err, file) .

Se um objeto for passado, o file.contents ou file.content poderá ser usado (para gulp e montar compatibilidade).

Params

file {string | objeto} : o objeto ou string para analisar.
options {Object | function} : ou next função de retorno de chamada. As opções são passadas para a mata-cinza.
next {function} : função de retorno de chamada.

Exemplo

 // 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'}}
} ) ;

.ParSesSync

Analisar o assunto frontal da string fornecida ou do contents no file fornecido. Se um objeto for passado, o file.contents ou file.content poderá ser usado (para gulp e montar compatibilidade).

Params

file {string | objeto} : o objeto ou string para analisar.
options {objeto} : passado para a mata-cinza.

Exemplo

 // 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'}}

objeto de arquivo

Os objetos file retornados têm as seguintes propriedades (nenhuma outra propriedade é modificada no arquivo fornecido):

data : dados da matéria frontal analisada
content : a sequência de conteúdo, excluindo a frente (montagem de compatibilidade)
contents : a sequência de conteúdo como um buffer, excluindo a frente
orig : a sequência de conteúdo original com a frente incluída

Sobre

Projetos relacionados

Cinza-mate: analise a frente de uma string ou arquivo. Rápido, confiável e fácil de usar. Paresi Yaml ... mais | Página inicial
Analisador de cache: cache e carga Parsers, similiar para consolidar os motores JS. | Página inicial
Parser-CSV: analisador CSV, compatível com o cache do analisador. | Página inicial

Contribuindo

Pull Pedidos e estrelas são sempre bem -vindos. Para insetos e solicitações de recursos, crie um problema.

Colaboradores

COMITES	Contribuinte
69	Jonschlinkert
2	Doowb

Construindo documentos

(O readme.md deste projeto é gerado pelo verbo, por favor, não edite o ReadMe diretamente. Qualquer alteração no ReadMe deve ser feita no modelo .verb.md readme.)

Para gerar o ReadMe, execute o seguinte comando:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Testes de execução

Executar e revisar os testes de unidade é uma ótima maneira de se familiarizar com uma biblioteca e sua API. Você pode instalar dependências e executar testes com o seguinte comando: