triggerdotdev/fuzzy-json-searchPublic

NotificationsYou must be signed in to change notification settings
Fork2
Star18

Search a JSON document by path, content, and inferred content

License

MIT license

18 stars 2 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 14 Commits
.github/workflows		.github/workflows
.vscode		.vscode
badges		badges
src		src
tests		tests
.eslintignore		.eslintignore
.eslintrc		.eslintrc
.gitignore		.gitignore
.npmignore		.npmignore
.prettierrc		.prettierrc
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
profile.js		profile.js
rollup.config.js		rollup.config.js
tsconfig.json		tsconfig.json

Repository files navigation

Fuzzy JSON Search

VSCode style fuzzy search for JSON documents

🚀 Features

Use VSCode style fuzzy search on a JSON document
Searches through key names, path, raw values and formatted values

💻 Usage

Install Fuzzy JSON Search

$ npm install --save @jsonhero/fuzzy-json-search

The simplest way to search is to create an instance ofJSONHeroSearch and pass it a JSON object:

constresponse=awaitfetch("https://jsonplaceholder.typicode.com/todos");constjson=awaitresponse.json();constsearcher=newJSONHeroSearch(json);constresults=searcher.search("user");

API

`JSONHeroSearch.search(query: string)`

Performs a fuzzy search against the entire document, ordering by score. Will only return results that score more than 0.

Returns`Array<SearchResult<string>>>`

SearchResult<string> has the following properties:

`item` is a`string` representing the path to the key

`score` is an`ItemScore`

`ItemScore` has the following properties

`score` is a number, the higher the score the better a match

`labelMatch` is an array of`Match` objects

`descriptionMatch` is an array of`Match` objects

`rawValueMatch` is an array of`Match` objects

`formattedValueMatch` is an array of`Match` objects

`Match` is type`{ start: number; end: number }`

About

Search a JSON document by path, content, and inferred content

Resources

Readme

License

MIT license

Code of conduct

Releases5

Export the scoreFuzzy function Latest

Apr 22, 2022

+ 4 releases

Packages

No packages published

Movatterモバイル変換

License

triggerdotdev/fuzzy-json-search

Folders and files

Latest commit

History

Repository files navigation

Fuzzy JSON Search

🚀 Features

💻 Usage

API

JSONHeroSearch.search(query: string)

ReturnsArray<SearchResult<string>>>

item is astring representing the path to the key

score is anItemScore

ItemScore has the following properties

score is a number, the higher the score the better a match

labelMatch is an array ofMatch objects

descriptionMatch is an array ofMatch objects

rawValueMatch is an array ofMatch objects

formattedValueMatch is an array ofMatch objects

Match is type{ start: number; end: number }

About

Resources

License

Code of conduct

Contributing

Uh oh!

Stars

Watchers

Forks

Releases5

Packages0

Uh oh!

Contributors3

Uh oh!

Languages

`JSONHeroSearch.search(query: string)`

Returns`Array<SearchResult<string>>>`

`item` is a`string` representing the path to the key

`score` is an`ItemScore`

`ItemScore` has the following properties

`score` is a number, the higher the score the better a match

`labelMatch` is an array of`Match` objects

`descriptionMatch` is an array of`Match` objects

`rawValueMatch` is an array of`Match` objects

`formattedValueMatch` is an array of`Match` objects

`Match` is type`{ start: number; end: number }`

Packages