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

trigram-search

v1.0.2

Published

trigram-based library for fast indexing and search over large arrays of data

Downloads

203

Readme

Trigram search

Trigram-based library for fast indexing and search over large arrays of data, written in TypeScript, built for Node.js and browser.

Demo

At codesandbox

Installation

npm i trigram-search

Usage

import Trigram from "trigram-search";
// or
// import Trigram from "trigram-search/build/browser";
const data = [{ id: 0, title: "Javascript" }, { id: 1, title: "Python" }, { id: 2, title: "Go" }, ...];
const searcher = new Trigram(data);

searcher.find('Py'); // will output sorted array of results

API

Constructor

new Trigram(items, config);

items — array of objects with id, title and optional sort fields (defaults).

id — must be unique

title — contains text for search

sort — can be used to prioritize specific items higher in the results, even if match rate for them is lower

config:

type TrigramConfig = {
  idField?: string; // key of the unique field of each item, default — "id"
  searchField?: string; // key of text-for-search field of each item, default — "title"
  sortField?: string; // key of sort field of each item, default — "sort"
  count?: number; // max length of the result array, default — "10"
  minRate?: number; // min match rate for item to be added to result, default — "0"
}

Methods

interface ITrigram {
  find(query: string, settings?: { count?: number; minRate?: number; }): TrigramOutput;
}

count and minRate in arguments will take precedence over global instance settings.

type TrigramOutput = {
  value: any; // item from input
  rate: number; // match rating of item for provided query    
}[];

Credits

Original TrigramJS algo by tqh.