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

@neosh11/autocomplete-search

v1.0.0

Published

This package enables you to perform prefix searches with exceptional speed.

Downloads

5

Readme

npm-autocomplete

Overview

If you use react -> here is a package that could handle everything for you => Link

This TypeScript module provides a simple implementation of an auto-complete search using a trie data structure. It supports searching for words with a given prefix and inserting words with associated IDs into the trie. The module also provides an option for case-insensitive search

| Function | Time | | ---------------------------------------------- | ------------------------------------------------------------------------- | | insert(word: string, id: string) | O(m), where m is the length of the word being inserted. | | findWords(prefix: string, maxCount?: number) | O(k + n), where n is the number of nodes, k is the lenght of the prefix |

Why use this and not a simple filter?

We tested out a simple filter on 100,000 tokens on the browser and these were the results:

| Method | Time (ms) | | ------------------ | --------- | | Simple filter | 467 | | autoCompleteSearch | 4 |

If you want your results to instantly load as you're typing with a lot of data, this library will be a life saver!

Usage

install

# if using yarn
yarn add @neosh11/autocomplete-search

# if using npm
npm install @neosh11/autocomplete-search

AutoCompleteSearch

Importing the module

import { AutoCompleteSearch } from '@neosh11/autocomplete-search';

Initializing the AutoCompleteSearch

To create an instance of AutoCompleteSearch, use the constructor and pass an optional SearchOptions object:

const searchOptions = { ignoreCase: true };
const autoCompleteSearch = new AutoCompleteSearch(searchOptions);

The ignoreCase option, if set to true, will perform case-insensitive search and insertions.

Inserting words

To insert words into the trie, use the insert method:

autoCompleteSearch.insert('example', 'id123');

This inserts the word "example" with the associated ID "id123" into the trie.

Searching for words

To search for words with a given prefix, use the findWords method:

const results = autoCompleteSearch.findWords('exa', 5);

This searches for words with the prefix "exa" and returns up to 5 associated IDs in an array.

By default, the maximum number of ids returned is 100

String2ObjectAutoCompleteSearch

Importing the module

import { String2ObjectAutoCompleteSearch } from '@neosh11/autocomplete-search';

Initializing the AutoCompleteSearch

To create an instance of AutoCompleteSearch, use the constructor and pass an optional SearchOptions object:

const searchOptions = {
  ignoreCase: true,
  objectIdProperty: 'id',
  tokenizer: ' ',
};
const autoCompleteSearch = new AutoCompleteSearch(searchOptions);

The ignoreCase option, if set to true, will perform case-insensitive search and insertions.

The objectIdProperty option will examine which property to use as a unique ID

The tokenizer option, if used will tokenize the search string

Inserting words

To insert words into the trie, use the insert method:

autoCompleteSearch.insert('example', object);

This inserts the object with the word 'example'.

Searching for words

To search for words with a given prefix, use the findWords method:

const results = autoCompleteSearch.findObjects('exa', 5);

This searches for words with the prefix "exa" and returns up to 5 associated objects which match this description.

By default, the maximum number of ids returned is 100