Norvell's Public Machinations
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    highlights-email-to-jsonpublic

    Convert an email export of notes into a JSON object. This is handy for saving notes from Instapaper or directly from the web.

    Installation

    npm install highlights-email-to-json --save
    

    Expected email format

    The email you send must match the following format in order to be converted by this package.

    ---
    title: Book Title
    authors: Author Name; Another author name
    ---
    Note one text.
    
    
    Note two text.
    

    Note: The front-matter section at the top will accept any attribute.

    API

    toJSON(email) ⇒ Promise.<Object>

    Convert a notes email export into a JSON object. Rejects if the mail isn't a valid notes export.

    Param Type
    email Buffer | Stream | String

    Example

    const toJSON = require("highlights-email-to-json");
    const email = readFile(emailPath);
     
    toJSON(email).then(data => {
      console.log(data);
    });

    Keywords

    none

    install

    npm i highlights-email-to-json

    Downloadslast 7 days

    6

    version

    1.0.3

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar