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

@iosio/fuse-worker

v0.7.12

Published

> Delegates fuse.js fuzzy search to a worker thread.

Downloads

20

Readme

@iosio/fuse-worker

Delegates fuse.js fuzzy search to a worker thread.

Installation

npm install @iosio/fuse-worker

Requires configuring your build system to copy the worker file from node_modules to the root of the build destination where the application is served from.

Copy path: 'node_modules/@iosio/fuse-worker/lib/fuse.worker.js'

(As of now, version 3.4.5 of fuse.js is bundled with the worker file)

Usage

To create a new fuse worker, import FuseWorker and call the factory function that creates and connects to a web worker.

import {FuseWorker} from '@iosio/fuse-worker';

const fuse = FuseWorker({
    workerURL: './path/to/fuse.worker.js', // defaults to './fuse.worker.js'.
    list: [], //optionally pass the list to perform the search in, or set the list using fuse.set({list}) .
    options: {}, //optionally merge options into the default fuse.js options config or use fuse.set({options}) .
})

fuse options: See https://fusejs.io/ for more info on fuse.js and the available options. The following is what exists as the default options.

let options = {
    shouldSort: true,
    minMatchCharLength: 1,
    findAllMatches: true,
    keys: ['name'],
    maxPatternLength: 50,
    threshold: 0.4,
    distance: 1000,
    location: 0,
    ...options //any options you pass will be merged in here
};

fuse.set As stated above, the list and options on the fuse worker instance may be updated by calling fuse.set


fuse.set({
    list: [...your_new_list_to_search_in],
    options: {...any_new_options}
});

fuse.search To perform a search, call fuse.search passing a string text value as the first argument and a callback function as the second argument.

fuse.search('some value to search for', (results) => {
    console.log('the results from fuse.js', results)
});