{"id":13606237,"url":"https://github.com/wouterrutgers/fuzzy-search","last_synced_at":"2025-04-09T21:20:13.565Z","repository":{"id":7462590,"uuid":"56446229","full_name":"wouterrutgers/fuzzy-search","owner":"wouterrutgers","description":"Simple fuzzy search","archived":false,"fork":false,"pushed_at":"2023-03-14T23:52:27.000Z","size":1180,"stargazers_count":223,"open_issues_count":16,"forks_count":28,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-15T09:31:01.177Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wouterrutgers.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-04-17T16:20:11.000Z","updated_at":"2024-10-06T15:53:09.000Z","dependencies_parsed_at":"2024-01-12T10:27:13.253Z","dependency_job_id":"0b74e545-24f1-47f3-a5ea-569be655029a","html_url":"https://github.com/wouterrutgers/fuzzy-search","commit_stats":{"total_commits":79,"total_committers":7,"mean_commits":"11.285714285714286","dds":"0.10126582278481011","last_synced_commit":"dc0618e9c80894aa01f2f2a1d59903ac4b10c50f"},"previous_names":["wouter2203/fuzzy-search"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wouterrutgers%2Ffuzzy-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wouterrutgers%2Ffuzzy-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wouterrutgers%2Ffuzzy-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wouterrutgers%2Ffuzzy-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wouterrutgers","download_url":"https://codeload.github.com/wouterrutgers/fuzzy-search/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246150432,"owners_count":20731419,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T19:01:07.455Z","updated_at":"2025-04-02T19:06:55.522Z","avatar_url":"https://github.com/wouterrutgers.png","language":"JavaScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=NUA68T5TCC2BN"],"categories":["JavaScript","Text Search"],"sub_categories":["Fuzzy search"],"readme":"# Fuzzy search\n\n*Simple lightweight Fuzzy Search library written in JavaScript, with zero dependencies!*\n\n[![Travis](https://img.shields.io/travis/wouter2203/fuzzy-search/master.svg)](https://travis-ci.org/wouter2203/fuzzy-search)\n[![npm](https://img.shields.io/npm/v/fuzzy-search.svg)](https://www.npmjs.com/package/fuzzy-search)\n[![npm](https://img.shields.io/npm/dm/fuzzy-search.svg)](https://www.npmjs.com/package/fuzzy-search)\n[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=NUA68T5TCC2BN)\n\n## Installation\n\n\u003e Using npm\n\n`npm install fuzzy-search --save`\n\n\u003e Using `\u003cscript\u003e`\n\n`\u003cscript src=\"FuzzySearch.js\"\u003e\u003c/script\u003e`\n\n## Quick start guide\n```javascript\n// This can be excluded when loaded via \u003cscript\u003e\nimport FuzzySearch from 'fuzzy-search'; // Or: var FuzzySearch = require('fuzzy-search');\n\nconst people = [{\n  name: {\n    firstName: 'Jesse',\n    lastName: 'Bowen',\n  },\n  state: 'Seattle',\n}];\n\nconst searcher = new FuzzySearch(people, ['name.firstName', 'state'], {\n  caseSensitive: true,\n});\nconst result = searcher.search('ess');\n```\n\n## Documentation\n```javascript\nconst searcher = new FuzzySearch(\u003chaystack\u003e, [keys], [options]);\nconst result = searcher.search(\u003cneedle\u003e);\n```\n\n**haystack** *(type: `Array`)*\n\nArray of objects containing the search list.\n\n---\n\n**[keys]** *(type: `Array`, default: `[]`)*\n\nList of properties that will be searched. This also supports nested properties.\n\n---\n\n**[options]** *(type: `Object`)*\n\nObject with options that will configure the search. Scroll/Swipe down to see more information on what options are available.\n\n---\n\n**\\\u003cneedle\\\u003e** *(type: `String`, default: `''`)*\n\nThe string to Fuzzy Search on.\n\n### Options\n**caseSensitive** *(type: `Boolean`, default: `false`)*\n\nIndicates whether comparisons should be case sensitive.\n\n**sort** *(type: `Boolean`, default: `false`)*\n\nWhen `true` it will sort the results by best match (when searching for `abc` in the search set `['a__b__c', 'abc']` it would return `abc` as the first result).\n\nWhen `false` it will return the results in the original order.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwouterrutgers%2Ffuzzy-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwouterrutgers%2Ffuzzy-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwouterrutgers%2Ffuzzy-search/lists"}