parser front matter Download - parser front matter Source Code Download

parser front matter

Andere Kategorien

1.0.0

Herunterladen

Parser-Front-Materie

Front Materie analysieren Middleware basierend auf Grau-Materie.

Installieren

Installieren Sie mit NPM:

$ npm install --save parser-front-matter

Dies ähnelt einer Konsolidierung.js -Motor, jedoch zum Parsen. Arbeitet mit Montage, Verb, Generieren, Update, Express.js, Parser-Cache oder einer Anwendung mit ähnlichen Konventionen.

Verwendung

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

API

.Parse

Front Materie aus der angegebenen Zeichenfolge oder dem contents in der angegebenen file und in der next(err, file) analysieren.

Wenn ein Objekt übergeben wird, kann entweder file.contents oder file.content verwendet werden (für die Kompatibilität für Schläfen und Zusammenstellen).

Parameter

file {String | Objekt} : Das Objekt oder Zeichenfolge analysiert.
options {Objekt | Funktion} : oder next Rückruffunktion. Die Optionen werden an Grey-Materie übergeben.
next {Funktion} : Rückruffunktion.

Beispiel

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

.Parseync

Front Materie aus der angegebenen Zeichenfolge oder dem contents in der angegebenen file analysieren. Wenn ein Objekt übergeben wird, kann entweder file.contents oder file.content verwendet werden (für die Kompatibilität für Schläfen und Zusammenstellen).

Parameter

file {String | Objekt} : Das Objekt oder Zeichenfolge analysiert.
options {Objekt} : an Grey-Materie übergeben.

Beispiel

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

Dateiobjekt

Zurückgegebene file haben die folgenden Eigenschaften (in der angegebenen Datei werden keine anderen Eigenschaften geändert):

data : Daten von analysierter Front Materie
content : Die Inhaltszeichenfolge ohne Front-Materie (Kompatibilität zusammenstellen)
contents : Die Inhaltszeichenfolge als Puffer ohne Front-Materie
orig

Um

Beitragen

Zuganfragen und Sterne sind immer willkommen. Für Fehler und Funktionsanfragen erstellen Sie bitte ein Problem.

Mitwirkende

Sich verpflichtet	Mitwirkender
69	Jonschlinkert
2	Doowb

Aufbau von Dokumenten

(Die Readme.md dieses Projekts wird per Verb generiert. Bearbeiten Sie die Readme nicht direkt. Alle Änderungen an der Readme müssen in der Vorlage.

Führen Sie den folgenden Befehl aus, um den Readme zu generieren:

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

Auslauftests

Das Ausführen und Überprüfen von Unit -Tests ist eine großartige Möglichkeit, sich mit einer Bibliothek und ihrer API vertraut zu machen. Sie können Abhängigkeiten installieren und Tests mit dem folgenden Befehl ausführen: