Descargar parser front matter - Descargar el código fuente parser front matter

parser front matter

Otras categorias

1.0.0

Descargar

analgésico

Medias de análisis de la materia frontal basado en grises.

Instalar

Instalar con NPM:

$ npm install --save parser-front-matter

Esto es similar a un motor consolidate.js, pero para el análisis. Funciona con ensamblar, verbo, generar, actualizar, express.js, analgésicos o cualquier aplicación con convenciones similares.

Uso

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

API

.analizar gramaticalmente

Analice la materia frontal de la cadena dada o el contents en el file y la devolución de llamada dada next(err, file) .

Si se pasa un objeto, se puede usar file.contents o file.content (para GULP y ensamble la compatibilidad).

Parámetros

file {String | Object} : el objeto o cadena para analizar.
options {objeto | función} : o next función de devolución de llamada. Las opciones se pasan a grises.
next {function} : función de devolución de llamada.

Ejemplo

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

.Parsesync

Analizar la materia frontal de la cadena dada o el contents en el file dado. Si se pasa un objeto, se puede usar file.contents o file.content (para GULP y ensamble la compatibilidad).

Parámetros

file {String | Object} : el objeto o cadena para analizar.
options {Object} : pasada a gris-materia.

Ejemplo

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

archivo de archivo

Los objetos file devuelto tienen las siguientes propiedades (no se modifican otras propiedades en el archivo dado):

data : datos de la parte delantera analizada
content : la cadena de contenido, excluyendo la materia frontal (ensamblar compatibilidad)
contents : la cadena de contenido como un amortiguador, excluyendo la materia frontal
orig : la cadena de contenido original con la materia frontal incluida

Acerca de

Proyectos relacionados

Gray-Matter: analice la parte delantera de una cadena o archivo. Rápido, confiable y fácil de usar. Parses Yaml ... más | página principal
Parser-Cache: caché y analizadores de carga, similar a los motores Consolidate.js. | página principal
PARSER-CSV: PARSER CSV, compatible con Parser-Cache. | página principal

Que contribuye

Las solicitudes y las estrellas siempre son bienvenidas. Para errores y solicitudes de funciones, cree un problema.

Colaboradores

Compromiso	Contribuyente
69	jonschlinkert
2	doowb

Construcción de documentos

(El verbo genera el readMe.md de este proyecto, no edite el readMe directamente. Cualquier cambio en el ReadMe debe realizarse en la plantilla .verb.md ReadMe).

Para generar el ReadMe, ejecute el siguiente comando:

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

Pruebas de ejecución

Ejecutar y revisar las pruebas unitarias es una excelente manera de familiarizarse con una biblioteca y su API. Puede instalar dependencias y ejecutar pruebas con el siguiente comando: