https://github.com/guidsdo/matchfuzzy

Match your query fuzzy on given target
https://github.com/guidsdo/matchfuzzy

Last synced: about 1 year ago
JSON representation

Match your query fuzzy on given target

• Host: GitHub
• URL: https://github.com/guidsdo/matchfuzzy
• Owner: guidsdo
• License: apache-2.0
• Created: 2018-05-23T15:14:00.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-10-19T09:05:18.000Z (over 2 years ago)
• Last Synced: 2024-03-24T17:21:35.920Z (about 2 years ago)
• Language: TypeScript
• Size: 117 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# matchFuzzy()

Match your query fuzzy on given target

[![Build Status](https://travis-ci.org/guidojo/matchFuzzy.svg?branch=master)](https://travis-ci.org/guidojo/matchFuzzy)

[![npm version](https://badge.fury.io/js/matchfuzzy.svg)](https://badge.fury.io/js/matchfuzzy)

[![Coverage Status](https://coveralls.io/repos/github/guidojo/matchFuzzy/badge.svg?branch=master)](https://coveralls.io/github/guidojo/matchFuzzy?branch=master)

[![Known Vulnerabilities](https://snyk.io/test/github/guidojo/matchFuzzy:package.json/badge.svg?targetFile=package.json)](https://snyk.io/test/github/guidojo/matchFuzzy:package.json?targetFile=package.json)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

## Example (UI excluded)

Input = `he`

Result = highlighted characters



## Usage

Below is the type definition of the exported functions. For any issues or questions, just create an issue and I'll respond asap.

```typescript

export declare type MatchResult = {

    offset: number;

    positions: number[];

    extraChars: number;

    trailingChars: number;

};

/**

 * Try to find a given query in a given target in a "fuzzy" manner.

 *

 * @param query the string you search with

 * @param target the string you search in

 * @param characterLimit maximum amount of characters in result. Example: { " ": 6, ".": 0 } means a sentence with a maximum of 6 spaces.

 */

export declare function matchFuzzy(query: string, target: string, characterLimit?: {

    [character: string]: number;

}): MatchResult | null;

/**

 * Array sort function in order: extra chars, offset, trailing chars.

 *

 * @param a result a

 * @param b result b

 */

export declare function sort(a: MatchResult, b: MatchResult): 1 | -1 | 0;

```