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

gmatch

v4.0.6

Published

Search for a pattern in a stream as fast as JavaScriptly possible.

Downloads

502

Readme

gmatch img.shields.io/bundlephobia/minzip/gmatch

streamingmatch lets you search for a pattern in a stream as fast as JavaScriptly possible.

Works in the browser. No runtime dependencies. Constant memory usage. Faster than streamsearch.

gmatch.gif

Installation

npm i gmatch

Or import directly from a CDN:

import { Match } from "https://cdn.jsdelivr.net/npm/gmatch/+esm";

API

Match

The Match class implements a streaming Boyer-Moore-Horspool-Sunday (BMHS) pattern matching algorithm.

Constructor

new Match(pattern, callback);

new Match(pattern, callback, Buffer.from);
  • pattern (Uint8Array|string): The pattern to search for. Must be between 1 and 256 characters long.
  • callback (Function): The function to be called when there's a match or when a chunk of data is processed.
  • from (Function, optional): Custom Buffer.from implementation for runtimes like Node.js. Defaults to an internal, browser-compatible function.

The constructor may throw:

  • TypeError: If the callback is not a function or if the pattern is not a string.
  • RangeError: If the pattern is empty.

Properties

  • matches (number): Returns the number of matches found.
  • lookbehindSize (number): Returns the size of the fed data that hasn't yet been processed.

Methods

  • destroy(): Calls the callback with any remaining lookbehind data and calls reset().
  • reset(): Resets the internal state.
  • write(chunk: Uint8Array|string): Feeds a chunk of data.

Callback Parameters

  • isMatch (boolean): Indicates whether a match is found.
  • data (Uint8Array | null): Buffer containing data that is not part of a match.
  • start (number): The start index of the data that doesn't contain the pattern.
  • end (number): The end index (exclusive) of the data that doesn't contain the pattern.
  • isSafe (boolean): Indicates whether it's safe to store a reference to data without copying it.

Usage

import { Match } from "gmatch";

const matcher = new Match("example", (isMatch, data, start, end, isSafe) => {
  console.log(isMatch, data, start, end, isSafe);
});

matcher.write("Some text with an example in it");
matcher.write(" and more exam");
matcher.write("ple here");
matcher.destroy();

console.log(`Total matches: ${matcher.matches}`);

You can use the Match class with various types of data sources, including streams, by calling the write method with chunks of data as they become available.

The implementation is optimized for both Node.js environments (Buffer) and browser environments (Uint8Array).

Benchmarks

Latest results:

┌─────────┬────────────────┬───────────┬────────────────────┬──────────┬─────────┐
│ (index) │ Task Name      │ ops/sec   │ Average Time (ns)  │ Margin   │ Samples │
├─────────┼────────────────┼───────────┼────────────────────┼──────────┼─────────┤
│ 0       │ 'gmatch'       │ '327,280' │ 3055.4854687296574 │ '±0.15%' │ 1636402 │
│ 1       │ 'streamsearch' │ '289,082' │ 3459.2213706394214 │ '±0.15%' │ 1445413 │
└─────────┴────────────────┴───────────┴────────────────────┴──────────┴─────────┘

gmatch matches: 12
streamsearch matches: 12

Acknowledgments

Inspired by the excellent streamsearch package, both of which implement FooBarWidget's streaming Boyer-Moore-Horspool algorithm.