# furry-text-search

> A very simple furry/fuzzy text search library based on Fuse.js

Latest version **0.5.2** (published 2024-04-26) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install furry-text-search
pnpm add furry-text-search
yarn add furry-text-search
bun add furry-text-search
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.2 |
| Published | 2024-04-26 |
| First published | 2023-07-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 57.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ish |
| Maintainers | ish0 |
| Keywords | fuzzy, search, text, index |

## Links

- npm: https://www.npmjs.com/package/furry-text-search
- Repository: https://github.com/dvorakroth/furry-text-search
- Homepage: https://github.com/dvorakroth/furry-text-search#readme
- Issues: https://github.com/dvorakroth/furry-text-search/issues
- npm.io page: https://npm.io/package/furry-text-search

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.5.2 (latest) — 2024-04-26
- 0.5.1 — 2024-04-17
- 0.5.0 — 2024-04-16
- 0.4.0 — 2024-04-08
- 0.3.0 — 2024-03-28
- 0.2.0 — 2023-07-18
- 0.1.0 — 2023-07-18

## README

furry-text-search
=================

[![NPM Version](https://img.shields.io/npm/v/furry-text-search)](https://www.npmjs.com/package/furry-text-search)

furry-text-search is a library written in TypeScript to handle furry/fuzzy, imprecise, forgiving text search. It is based on [Fuse.js](https://github.com/krisk/Fuse) albeit greatly simplified, and converted to proper TypeScript.

This library is probably not for everyone. I forked it specifically to use [in a project](https://bus-alerts.com/) where I needed a library like Fuse.js, but didn't need all of its features.

If you need more advanced features, there's a good chance you shouldn't be using this library lol

How to use
----------

(The same code sample is also available in [example.ts](example.ts))

```typescript
import { FurryIndex } from "./dist";

type BusLine = {
  routeShortName: string;
  agencyId: number;
  cities: string[];
};

type TransitAgency = {
  agencyId: number;
  agencyName: string;
};

// some example data
const agencies: Record<number, TransitAgency> = {
  1: {
    agencyId: 1,
    agencyName: "Egged",
  },
  2: {
    agencyId: 2,
    agencyName: "Dan",
  },
  3: {
    agencyId: 3,
    agencyName: "Metropoline",
  },
};

const lines: BusLine[] = [
  {
    routeShortName: "74",
    agencyId: 1,
    cities: ["Tel Aviv - Yafo", "Rishon LeZion", "Azor"],
  },
  {
    routeShortName: "201",
    agencyId: 1,
    cities: [
      "Tel Aviv - Yafo",
      "Azor",
      "Rishon LeZion",
      "Rehovot",
      "Nes Ziona",
    ],
  },
  {
    routeShortName: "1",
    agencyId: 2,
    cities: [
      "Bat Yam",
      "Tel Aviv - Yafo",
      "Ramat Gan",
      "Bney Brak",
      "Petah Tikva",
    ],
  },
  {
    routeShortName: "25",
    agencyId: 2,
    cities: ["Holon", "Bat Yam", "Tel Aviv - Yafo"],
  },
  {
    routeShortName: "24",
    agencyId: 3,
    cities: ["Ramat HaSharon", "Tel Aviv - Yafo"],
  },
];

// create an index to search through
const searchIndex = new FurryIndex<BusLine>(
  // the data to search through
  lines,

  // the fields we allow searching through, and their weight in scoring
  [
    {
      get: (line) => line.routeShortName,
      weight: 1,
    },
    {
      get: (line) => agencies[line.agencyId]?.agencyName ?? "",
      weight: 0.1,
    },
    {
      get: (line) => line.cities,
      weight: 0.1,
    },
  ],

  // how to sort search results
  (a, b) => {
    if (a.score === b.score) {
      return a.obj.routeShortName.localeCompare(b.obj.routeShortName);
    } else {
      return a.score - b.score;
    }
  },
);

// run a search:
const result = searchIndex.search(
  // we don't have any cities with "Ramot" in the name,
  // but we DO have cities with "Ramat" in the name!
  ["Ramot"],

  // this threshold value was reached through trial and error sorry :<
  0.35,

  // don't return things that don't match
  false,
);

console.log(result);

// value of result:
[
  {
    furrySearchResult: true,
    isMatch: true,
    idx: 2,
    obj: {
      routeShortName: "1",
      agencyId: 2,
      cities: [
        "Bat Yam",
        "Tel Aviv - Yafo",
        "Ramat Gan",
        "Bney Brak",
        "Petah Tikva",
      ],
    },
    score: 0.8744852722211678,
    matches: [
      [], // no matches in first field (routeShortName)
      [], // no matches in second field (agencyName)
      [
        // matches in third field (cities)
        null, // no matches in first item ("Bat Yam")
        null, // no matches in second item ("Tel Aviv - Yafo")
        [
          // matches in third item ("Ramat Gan")
          [0, 3], // characters 0 through 3 ("Rama")
        ],
      ],
    ],
  },
  {
    furrySearchResult: true,
    isMatch: true,
    idx: 4,
    obj: {
      routeShortName: "24",
      agencyId: 3,
      cities: ["Ramat HaSharon", "Tel Aviv - Yafo"],
    },
    score: 0.8744852722211678,
    matches: [[], [], [[0, 3]]],
  },
];

```

---
_Source: https://npm.io/package/furry-text-search · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._