parser front matter

ตัวแยกวิเคราะห์หน้า

การแยกวิเคราะห์มิดเดิลแวร์ด้านหน้าของสสารขึ้นอยู่กับสีเทา

ติดตั้ง

ติดตั้งด้วย NPM:

$ npm install --save parser-front-matter

สิ่งนี้คล้ายกับเครื่องยนต์รวม js แต่สำหรับการแยกวิเคราะห์ ทำงานร่วมกับการประกอบ, คำกริยา, สร้าง, อัปเดต, express.js, parser-cache หรือแอปพลิเคชันใด ๆ ที่มีการประชุมที่คล้ายกัน

การใช้งาน

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

API

.parse

แยกวิเคราะห์เรื่องด้านหน้าจากสตริงที่กำหนดหรือ contents ใน file ที่กำหนดและการโทรกลับ next(err, file)

หากวัตถุถูกส่งผ่าน file.contents หรือ file.content อาจถูกใช้ (สำหรับความสามารถในการประกอบของ Gulp และ Assemble)

พารามิเตอร์

• file {สตริง | วัตถุ} : วัตถุหรือสตริงเพื่อแยกวิเคราะห์
• options {วัตถุ | ฟังก์ชั่น} : หรือฟังก์ชั่นโทรกลับ next ตัวเลือกจะถูกส่งผ่านไปยังสีเทา
• next {ฟังก์ชั่น} : ฟังก์ชั่นการโทรกลับ

ตัวอย่าง

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

แยกวิเคราะห์เรื่องด้านหน้าจากสตริงที่กำหนดหรือ contents ใน file ที่กำหนด หากวัตถุถูกส่งผ่าน file.contents หรือ file.content อาจถูกใช้ (สำหรับความสามารถในการประกอบของ Gulp และ Assemble)

พารามิเตอร์

• file {สตริง | วัตถุ} : วัตถุหรือสตริงเพื่อแยกวิเคราะห์
• options {Object} : ส่งผ่านไปยัง Grey-Matter

ตัวอย่าง

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

วัตถุไฟล์

วัตถุ file ที่ส่งคืนมีคุณสมบัติต่อไปนี้ (ไม่มีการแก้ไขคุณสมบัติอื่น ๆ ในไฟล์ที่กำหนด):

• data : ข้อมูลจากเรื่องด้านหน้าที่แยกวิเคราะห์
• content : สตริงเนื้อหาไม่รวมด้านหน้า (ความเข้ากันได้ของการประกอบ)
• contents : สตริงเนื้อหาเป็นบัฟเฟอร์ไม่รวมด้านหน้า
• orig : สตริงเนื้อหาต้นฉบับที่มีด้านหน้ารวมอยู่ด้วย

เกี่ยวกับ

โครงการที่เกี่ยวข้อง

• สีเทา: แยกวิเคราะห์ด้านหน้าจากสตริงหรือไฟล์ รวดเร็วเชื่อถือได้และใช้งานง่าย Parses Yaml …เพิ่มเติม | หน้าแรก
• Parser-Cache: Cache and Load Parsers, Similiar to Consolidate.js Engines - หน้าแรก
• Parser-CSV: CSV Parser เข้ากันได้กับตัวแยกวิเคราะห์ - หน้าแรก

การบริจาค

ยินดีต้อนรับการร้องขอและดวงดาวเสมอ สำหรับข้อบกพร่องและคำขอคุณสมบัติโปรดสร้างปัญหา

ผู้มีส่วนร่วม

มุ่งมั่น	ผู้สนับสนุน
69	jonschlinkert
2	doowb

การสร้างเอกสาร

(readme.md ของโครงการนี้สร้างขึ้นโดยคำกริยาโปรดอย่าแก้ไข readme โดยตรงการเปลี่ยนแปลงใด ๆ ของ readMe จะต้องทำในเทมเพลต. verb.md readme)

ในการสร้าง readMe ให้เรียกใช้คำสั่งต่อไปนี้:

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

การทดสอบกำลังดำเนินการ

การทำงานและตรวจสอบการทดสอบหน่วยเป็นวิธีที่ดีในการทำความคุ้นเคยกับห้องสมุดและ API คุณสามารถติดตั้งการพึ่งพาและเรียกใช้การทดสอบด้วยคำสั่งต่อไปนี้:

$ npm install && npm test

ผู้เขียน

Jon Schlinkert

• GitHub/Jonschlinkert
• Twitter/Jonschlinkert

ใบอนุญาต

ลิขสิทธิ์© 2017, Jon Schlinkert ปล่อยภายใต้ใบอนุญาต MIT

---

ไฟล์นี้ถูกสร้างขึ้นโดย verb-generate-readme, v0.6.0, ในวันที่ 16 กรกฎาคม 2017