parser front matter Download - parser front matter Source Code Unduh

parser front matter

Kategori lainnya

1.0.0

Unduh

Parser-Front-Matter

Middleware parsing materi depan berdasarkan materi abu-abu.

Memasang

Instal dengan NPM:

$ npm install --save parser-front-matter

Ini mirip dengan mesin Consolidate.js, tetapi untuk penguraian. Bekerja dengan rakitan, kata kerja, menghasilkan, memperbarui, ekspres.js, parser-cache, atau aplikasi apa pun dengan konvensi yang sama.

Penggunaan

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

API

.parse

Parse Front Matter dari string yang diberikan atau contents dalam file yang diberikan dan panggilan balik next(err, file) .

Jika suatu objek dilewati, baik file.contents atau file.content .

Params

file {String | Object} : Objek atau String ke Parse.
options {Object | Function} : atau fungsi panggilan balik next . Opsi diteruskan ke materi abu-abu.
next {Function} : Fungsi Callback.

Contoh

 // 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 dari string yang diberikan atau contents dalam file yang diberikan. Jika suatu objek dilewatkan, baik file.contents atau file.content .

Params

file {String | Object} : Objek atau String ke Parse.
options {Object} : diteruskan ke materi abu-abu.

Contoh

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

objek file

Objek file yang dikembalikan memiliki properti berikut (tidak ada properti lain yang dimodifikasi pada file yang diberikan):

data : data dari materi depan parsed
content : String konten, tidak termasuk materi depan (rakitkan kompatibilitas)
contents : String konten sebagai buffer, tidak termasuk bahan depan
orig : String Konten Asli Dengan Termasuk Depan

Tentang

Proyek terkait

Grey-matter: Parse-matter depan dari string atau file. Cepat, andal dan mudah digunakan. Parses yaml… lebih | beranda
Parser-Cache: cache dan memuat parser, serupa dengan mesin konsolidasi.js. | beranda
Parser-CSV: Parser CSV, kompatibel dengan parser-cache. | beranda

Berkontribusi

Permintaan tarik dan bintang selalu diterima. Untuk bug dan permintaan fitur, silakan buat masalah.

Kontributor

Berkomitmen	Penyumbang
69	Jonschlinkert
2	doowb

Membangun dokumen

(README.MD proyek ini dihasilkan oleh kata kerja, tolong jangan mengedit readme secara langsung. Setiap perubahan pada readme harus dilakukan di template .verb.md readme.)

Untuk menghasilkan readme, jalankan perintah berikut:

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

Menjalankan tes

Menjalankan dan meninjau tes unit adalah cara yang bagus untuk membiasakan diri dengan perpustakaan dan API -nya. Anda dapat menginstal dependensi dan menjalankan tes dengan perintah berikut: