npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@notable/dumper

v4.0.3

Published

Library for extracting attachments, notes and metadata out of formats used by popular note-taking apps.

Downloads

13

Readme

Dumper

Library for extracting attachments, notes and metadata out of formats used by popular note-taking apps.

Features

  • Markdown: all notes are converted to Markdown automatically, no matter what format each note uses.
  • Modular: each supported format is implemented by a "provider", additional providers can be implemented easily, learn more about implementing one yourself here.
  • Lightweight: extra care has been taken to ensure this library is lightweight, no external DOM implementation is loaded by default and the most lightweight dependencies are being used.

Install

npm install --save @notable/dumper

Providers

The following providers are currently implemented:

  • Enex: it can import notes exported via Evernote.
    • Extensions: .enex.
  • Boostnote: it can import notes written using Boostnote.
    • Extensions: .cson.
  • HTML: it can import HTML notes, most popular note-taking apps can export to HTML.
    • Extensions: .html, .htm.
  • Markdown: it can import plain Markdown notes.
    • Extensions: .md, .mkd, .mkdn, .mdwn, .mdown, .markdown, .markdn, .mdtxt, .mdtext, .txt.

Usage

The following interfaces are provided:

interface Dumper {
  isSupported ( source: string ): boolean,
  dump ( options: Options ): Promise<void>
}

interface Options {
  DOMParser?: DOMParser, // This option is only optional if you are in a browser-like environment, e.i. "window.DOMParser" exists
  source: string | string[],
  dump ( note: Note ): void | Promise<void>
}

interface Note {
  metadata: {
    title: string,
    tags: string[],
    attachments: {
      metadata: {
        name: string,
        created: Date,
        modified: Date
      },
      content: Uint8Array
    }[],
    deleted: boolean,
    favorited: boolean,
    pinned: boolean,
    created: Date,
    modified: Date
  },
  content: Uint8Array
}

You can use the library like so:

import * as path from 'path';
import Dumper from '@notable/dumper';

Dumper.dump ({
  source: path.join ( __dirname, 'source.html' ),
  dump ( note ) {
    // Do something with each given note object...
  }
});

Contributing

There are multiple ways to contribute to this project, read about them here.

Related

  • Notable: The Markdown-based note-taking app that doesn't suck.

License

MIT © Fabio Spampinato