Flea

| service | status | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | Codecov | | | GitHub CI | |

An immutable, purely functional, type-safe micro-library that exposes some nice utilities for markdown-compilation post processing on both client and server.

Installation

You can install flea from npm:

npm i -s @hackdoor/flea

yarn add @hackdoor/flea

Exported Functions

The list of flea exported functions:

• anchors
• href
• readingTime

anchors

import { anchors } from "@hackdoor/anchors";

const replaceAnchors = anchors();

const myHTMLInput = `
  <div>
    <h1>Lorem Ipsum Dolor Sit Amet</h1>
    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit...</p>
    <h2>Consectetur Adipiscing Elit</h2>
    <p>Curabitur pretium tincidunt lacus. Nulla gravida orci a...</p>
    <h3>Sed Do Eiusmod Tempor Incididunt Ut</h3>
    <p>Ut ullamcorper, ligula eu tempor congue, eros est euism...</p>
  </div>
  `;

const result = replaceAnchors(myHTMLInput);

//  <div>
//    <h1>
//      <a id="lorem-ipsum-dolor-sit-amet" href="#lorem-ipsum-dolor-sit-amet" class="h-anchor">#</a>
//      Lorem Ipsum Dolor Sit Amet
//    </h1>
//    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit...</p>
//    <h2>
//      <a id="consectetur-adipiscing-elit" href="#consectetur-adipiscing-elit" class="h-anchor">#</a>
//      Consectetur Adipiscing Elit
//    </h2>
//    <p>Curabitur pretium tincidunt lacus. Nulla gravida orci a...</p>
//    <h3>
//      <a id="sed-do-eiusmod-tempor-incididunt-ut" href="#sed-do-eiusmod-tempor-incididunt-ut" class="h-anchor">#</a>
//      Sed Do Eiusmod Tempor Incididunt Ut
//    </h3>
//    <p>Ut ullamcorper, ligula eu tempor congue, eros est euism...</p>
//  </div>

href

import { href } from "@hackdoor/flea";

const replaceHrefs = href({ baseURL: "https://www.google.com" });

const myHTMLInput = `
  <div>
    <p> some text bla bla bla </p>
    <a href="https://www.google.com"> A link to Google </a> <br />
    <a href="https://www.bing.com"> A link to Bing </a> <br />
  </div>
`;

const result = replaceHrefs(myHTMLInput);

//  <div>
//    <p> some text bla bla bla </p>
//    <a href="https://www.google.com"> A link to Google </a> <br />
//    <a target="_blank" href="https://www.bing.com"> A link to Bing </a> <br />
//  </div>

Options

| name | required | type | default value | description | | --------- | -------- | --------- | ------------- | --------------------------------------------------------------------------------------------------------------------- | | baseURL | false | string | "" | the url to prevent for adding target="_blank" | | internals | false | boolean | false | set to true if you want to apply href to internals links too (those starting with /, for instance: /articles) |

readingTime

import { readingTime } from "@hackdoor/flea";
const myHTMLInput = `
  <div>
    <p> some text bla bla bla </p>
    <a href="https://www.google.com"> A link to Google </a> <br />
    <a href="https://www.bing.com"> A link to Bing </a> <br />
  </div>
`;

const readingInfo = readingTime({ text: myHTMLInput });

// {
//    duration: 0.0036363636363636364,
//    imageTime: 0,
//    otherLanguageTime: 0,
//    otherLanguageTimeCharacters: 0,
//    roundedDuration: 1,
//    totalImages: 0,
//    totalWords: 1,
//    wordTime: 0.0036363636363636364
// }

Options

| name | required | type | default value | description | | --------------------- | -------- | ---------- | -------------------- | -------------------------------------------------- | | text | true | string | "" | the text for calculate the reading time | | customWordTime | false | number | 275 | number of words read per minute | | customImageTime | false | number | 12 | maximum of seconds spent looking at an image | | chineseKoreanReadTime | false | number | 500 | number of chinese and korean words read per minute | | imageTags | false | string[] | [ 'img', 'Image' ] | list of tags to identify images |