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

search-in-js

v2.2.5

Published

This is a custom function designed to filter data in an array based on a search query. It provides flexibility in specifying the keys to search for within the data, as well as the type of search function to use.

Downloads

55

Readme

Array Data Filter Function

This is a custom function designed to filter data in an array based on a search query. It provides flexibility in specifying the keys to search for within the data, as well as the type of search function to use.

Usage

Installation

npm install search-in-js
yarn add search-in-js

Example

import { useState, useEffect } from "react";
import search from "search-in-js";

const ExampleComponent = () => {
  const data = [
    { id: 1, name: "test1", comment: { id: 1, text: "some comment" } },
    { id: 2, name: "test2", comment: { id: 2, text: "some other comment" } },
    // More data...
  ];

  // Define keys for searching
  const keys = ["id", "comment.text"];

  // State for search query and filtered data
  const [value, setValue] = useState("");
  const [filteredData, setFilteredData] = useState(data);

  // Update filtered data when search query changes
  useEffect(() => {
    setFilteredData(search(value, data, keys, "fuzzy"));
  }, [value]);

  return (
    <div>
      <input
        type="text"
        value={value}
        onChange={(e) => setValue(e.target.value)}
      />
      <ul>
        {filteredData.map((item) => (
          <li key={item.id}>{item.name}</li>
        ))}
      </ul>
    </div>
  );
};

API

search(value, data, keys, functionType)

  • value (string): The value to search for in the data.

  • data (Array<T>): The array of data to search.

  • keys (Array<string>): The array of keys to search for in the data.

    if you want to search by id and name, you can use the following keys: const keys = ["id", "name"];

    if you want to search by comments.id and comments.text, you can use the following keys: const keys = ["comments.id", "comments.text"];

  • functionType (SEARCH_FUNCTION, optional): The type of search function to use. Defaults to "fuzzy".

    Available search function types: equal, fuzzy, contains, starts-with, ends-with, starts-with-no-space, greater, less, greater-equal, less-equal

Returns: Array<T> - The filtered data based on the search query.

Contributing

Contributions are welcome! Please feel free to open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.


Feel free to modify and expand upon it to suit your needs!