parser front matter Download - parser front matter Code Source Download

parser front matter

Autres catégories

1.0.0

Télécharger

parse-front-met

Pandre de la matière avant middleware basé sur la matière grise.

Installer

Installer avec NPM:

$ npm install --save parser-front-matter

Ceci est similaire à un moteur Consolidate.js, mais pour l'analyse. Fonctionne avec assembler, verbe, générer, mettre à jour, express.js, analyser-cache ou toute application avec des conventions similaires.

Usage

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

API

.Pathse

Parse Front Matter à partir de la chaîne donnée ou du contents dans le file et rappel donné next(err, file) .

Si un objet est passé, file.contents ou file.content peut être utilisé (pour Gulp et assembler la compatibilité).

Paramètres

file {String | Object} : l'objet ou la chaîne à analyser.
options {Object | Fonction} : ou Fonction de rappel next . Les options sont transmises à la matière grise.
next {fonction} : fonction de rappel.

Exemple

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

Parse Front Matter de la chaîne donnée ou du contents dans le file donné. Si un objet est passé, file.contents ou file.content peut être utilisé (pour Gulp et assembler la compatibilité).

Paramètres

file {String | Object} : l'objet ou la chaîne à analyser.
options {Object} : passé à la matière grise.

Exemple

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

objet de fichier

Les objets file renvoyés ont les propriétés suivantes (aucune autre propriété n'est modifiée sur le fichier donné):

data : données du front de front analysé
content : la chaîne de contenu, à l'exclusion du front (assembler la compatibilité)
contents : la chaîne de contenu comme tampon, à l'exclusion du front
orig : La chaîne de contenu originale avec la matière de front

À propos

Projets connexes

Gray-Matter: analyser le front à partir d'une chaîne ou d'un fichier. Rapide, fiable et facile à utiliser. Parses Yaml… plus | page d'accueil
Parser-Cache: Parser Cache et Charge, similaire pour consolider les moteurs. | page d'accueil
Parser-CSV: Parser CSV, compatible avec l'analyse-cache. | page d'accueil

Contributif

Les demandes de tirage et les étoiles sont toujours les bienvenues. Pour les bogues et les demandes de fonctionnalités, veuillez créer un problème.

Contributeurs

Engagements	Donateur
69	jonschlinkert
2	doowb

Doct

(Readme.md de ce projet est généré par Verbe, veuillez ne pas modifier directement le ReadMe. Toute modification de la lecture doit être apportée dans le modèle .verb.md Readme.)

Pour générer le ReadMe, exécutez la commande suivante:

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

Tests en cours d'exécution

L'exécution et l'examen des tests unitaires sont un excellent moyen de se familiariser avec une bibliothèque et son API. Vous pouvez installer des dépendances et exécuter des tests avec la commande suivante: