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

sahtml-query

v2.0.0

Published

Downloads

1

Readme

sahtml-query

Fast and low memory query API for HTML (node.js).

Does not build DOM (Document Object Model).

Installation

yarn add sahtml-query

Usage

var parse = require('sahtml-query').parse;

var resultHref = null;
var resultText = '';
parse(
    '<!doctype><html lang="en"><body><a id="hello" href="http://example.com">Hello <span>World</span></a></body></html>',
    (document) => {
        document.onElement('#hello', (link) => {
            resultHref = link.element.attrs.href;
            link.onElement('span', (span) => {
                span.onText(({text}) => resultText += text);
            });
        });
    }
);

console.log(resultHref); // http://example.com
console.log(resultText); // World

API

/**
 * Parses the specified HTML fragment and creates context in order to query
 * the contents of the HTML fragment.
 */
export function parse(html: string, parseCallback: ParseCallback);

export type ParseCallback = (context: DocumentContext) => void;

/**
 * Context which is passed to the callbacks of both `parse`
 * and `onElement` methods.
 */
export interface DocumentContext {
    /**
     * Matches subelement of the specified context.
     */
    onElement(cssSelector: string, callback: OnElementCallback);

    /**
     * Matches every text fragment of the specified context.
     */
    onText(callback: OnTextCallback);

    /**
     * This callback will be executed after leaving the context.
     */
    after(callback: () => void);
}

export interface ElementContext extends DocumentContext {
    /**
     * HTML element information.
     */
    element: SAElement;

    /**
     * Checks if the current element matches the specified selector.
     */
    matches(selector: string): boolean;
}

export interface TextContext extends DocumentContext {
    /**
     * HTML text.
     */
    text: string;

    /**
     * Checks if the current element matches the specified selector.
     */
    matches(selector: string): boolean;
}

export type OnElementCallback = (context: ElementContext) => void;
export type OnTextCallback = (context: TextContext) => void;

/**
 * HTML element.
 */
export interface SAElement {
    /** HTML element tag name, always lower case */
    tagName: string;
    /** HTML element attributes */
    attrs: {[key: string]: string};
    /** Is true when HTML element auto closes, i.e. <img /> */
    autoEnd: boolean;
}