lwagf / know-parser

A simple plugin-based parser package

know-parser

know-parser is a JavaScript plugin-based package designed to extract useful data from a piece of text

This package comes bundled with a few pre-existing plugins to use right out of the box. If you would like to create your own plugins, see ./PLUGIN_DEVELOPMENT.md

This plugin was inspired by knwl.js

Installation

npm install --save know-parser

Usage Guide

Example script

const parser = require("know-parser");
const knowParser = new parser("a bunch of words with an email: [e-mail]");

const emails = knowParser.get("emails");
console.log(emails); // output: ["[e-mail]"]

Detailed walkthrrough

1. Create a new instance of know-parser

   const parser = require("know-parser");
   const knowParser = new parser();

2. Provide a piece of text to parse

   // string
   knowParser.lines = "this is a piece of text";
   
   // array
   knowParser.lines = ["an array", "of words"];
   
   // you can also provide lines via the constructor
   const knowParser = new parser("this is a piece of text");

3. Run a plugin on the piece of text

   const emails = knowParser.get("emails");
   console.log(emails); // an array of email addresses

Default Plugins

These are automatically loaded by default.

emails

const emails = knowParser.get("emails");
console.log(emails); // An array of email addresses

phones

const phones = knowParser.get('phones');
console.log(phones); // An array of phone numbers

Developing Parser Plugins

Because of the plugin-based nature of this package, it's surprisingly simple to create your own plugins for know-parser. If you would like to contribute to/create a plugin please see ./PLUGIN_DEVELOPMENT.md