🚀 Socket Launch Week Day 5:Introducing Repository Access Permissions and Custom Roles.Learn more →
Sign In

fuzzball

Package Overview
Dependencies
Maintainers
1
Versions
132
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fuzzball - npm Package Compare versions

Comparing version
2.2.1
 to
2.2.2
+1
-1
package.json
{
"name": "fuzzball",
"version": "2.2.1",
"version": "2.2.2",
"description": "Fuzzy string matching algorithms and utilities, port of the TheFuzz Python library.",

@@ -5,0 +5,0 @@ "main": "fuzzball.js",

+12
-11
README.md

@@ -1,2 +0,2 @@

[![Build Status](https://travis-ci.com/nol13/fuzzball.js.svg?branch=master)](https://travis-ci.com/nol13/fuzzball.js) [![Try fuzzball on RunKit](https://badge.runkitcdn.com/fuzzball.svg)](https://runkit.com/npm/fuzzball)
![Build Status](https://github.com/nol13/fuzzball.js/actions/workflows/node-ci.yml/badge.svg)

@@ -13,3 +13,4 @@ ![fuzzball.js logo](fuzzballlogo.jpg "feed me strings!")

* [Installation](#installation)
* [Usage and Scoring Overview](#usage)
* [Basic Usage](#basic-usage)
* [Functions](#functions)
* [Pre-Processing](#pre-processing)

@@ -55,6 +56,4 @@ * [Collation and Unicode Stuff](#collation-and-unicode-stuff)

# Usage
# Basic Usage
**Basic Overview**
```js

@@ -83,6 +82,4 @@ fuzz = require('fuzzball');

fuzz.extractAsync("mr. harry hood", choices, options, function (err, results){/* do stuff */});
results = await fuzz.extractAsPromised("mr. harry hood", choices, options);
fuzz.extractAsPromised("mr. harry hood", choices, options).then(res => {/* do stuff */});
// Cancel search

@@ -102,2 +99,4 @@

# Functions
**Simple Ratio**

@@ -176,2 +175,4 @@

# Options
### Pre-Processing

@@ -200,3 +201,3 @@

To use collation when calculating edit distance, set **useCollator** to true. Will be ignored if Intl.Collator does not exist in your enviroment. (node 0.10 and under, IE10 and under)
To use collation when calculating edit distance, set **useCollator** to true.

@@ -219,3 +220,3 @@ Setting useCollator to true will have an impact on performance, so if you have really large number of choices may be best to pre-process (i.e. lodash _.deburr) instead if possible.

When astral is true it will also normalize your strings before scoring, as long as String.prototype.normalize exists in your environment, but will not attempt to polyfill. (So if you need to compare unnormalized strings in IE, normalize separately) You can set the **normalize** option to false if you want different representations not to match, but is true by default.
When astral is true it will also normalize your strings before scoring. You can set the **normalize** option to false if you want different representations not to match, but is true by default.

@@ -330,3 +331,3 @@

When using extractAsPromised or extractAsync, you might want to cancel the action before it has finished.
When using extractAsPromised or extractAsync (callback style), you might want to cancel the action before it has finished.
It can be done using `AbortController`.

@@ -333,0 +334,0 @@