npm stats
  • Search
  • About
  • Repo
  • Sponsor
  • more
    • Search
    • About
    • Repo
    • Sponsor

Made by Antonio Ramirez

parse-files

0.1.1

@jonschlinkert

npmHomeRepoSnykSocket
Downloads:44
$ npm install parse-files
DailyWeeklyMonthlyYearly

parse-files NPM version

Complimentary lib to parser-cache. Extends the Parsers prototype with additional methods for reading files from the file system.

Install

Install with npm:

npm i parse-files --save-dev

Usage

var Parsers = require('parse-files');
var parsers = new Parsers();

API

.parseFile

Asynchronously read and parse a file at the given filepath and callback next(err, str).

  • filepath {String}: The file to parse.
  • options {Object|Function}: or next function.
  • next {Function}: Callback function.

Example:

parsers.parseFile('docs/abc.md', function (err, file) {
  console.log(file);
});

.parseFiles

Synchronously read and parse a glob of files from the given patterns and callback next(err, str). Options are passed to globby and .parseFile().

  • glob {String}: Glob patterns to use for files to parse.
  • options {Object|Function}: or next function.
  • next {Function}: Callback function.

Example:

parsers.parseFiles('docs/*.md', function (err, files) {
  console.log(files);
});

Related

  • parser-cache
  • parser-noop
  • parser-front-matter

Author

Jon Schlinkert

  • github/jonschlinkert
  • twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license


This file was generated by verb-cli on August 27, 2014.