first-x

0.1.0 • Public • Published

First x

Utility to extract the content of the first occurence of element x from HTML or Markdown

Build Status npm version MIT License

Install

$ npm install first-x
 
# or 
 
$ yarn add -D first-x

Usage

The following HTML and markdown elements/syntaxt are supported using relevant functions:

  • HTML header tags (h1, h2, h3, etc...) and their markdown counterparts
  • HTML image tag (img) and it's markdown counterpart
  • HTML paragraph tag (p) and it's markdown counterpart
  • HTML blockquote tag (blockquote) and it's markdown counterpart

All supported elements/syntaxt have the following functions available:

  • from_any - extracts content from first found occurence regardless of syntax
  • from_html - exclusively checks html
  • from_md (alias of from_markdown) - exclusively checks markdown

More details in Extractor class.

const FIRST = require('first-x');
 
// -----------------------------------------------------------------------------
 
// get first header text from some content
 
const title = FIRST.header.from_any( content );
 
// -----------------------------------------------------------------------------
 
// extract paragraph content exclusively from markdown
 
const description = FIRST.p.from_md( content );
 
// -----------------------------------------------------------------------------
 
// extract image url exclusively from html
 
const img_url = FIRST.img.from_html( content );
 
// -----------------------------------------------------------------------------
 
// get first found blockquote content
 
const quote = FIRST.blockquote.from_any( content );
 

License

MIT © webmasterish

Package Sidebar

Install

npm i first-x

Weekly Downloads

2

Version

0.1.0

License

MIT

Unpacked Size

8.1 kB

Total Files

13

Last publish

Collaborators

  • webmasterish