Installations

npm install @types/string-similarity

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Score

100

Supply Chain

77.4

Quality

75.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

155

Total

60,626

Closed

9,567

Merged

50,904

Issues

Open

562

Total

8,072

Closed

7,510

Releases

1

0.1.450

Published on 04 Sept 2019

View all 1 releases

Contributors

9,977

View all 9,977 contributors

Languages

3

TypeScript

JavaScript

Shell

TypeScript (99.9%)

JavaScript (0.09%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

17,809,504

Last Day

25,006

Last Week

112,961

Last Month

501,994

Last Year

5,948,110

GitHub Statistics

49,109 Stars

88,636 Commits

30,292 Forks

640 Watching

5 Branches

9,977 Contributors

Maintainers

1

Package Meta Information

Latest Version

4.0.2

Package Id

@types/string-similarity@4.0.2

Unpacked Size

5.61 kB

Size

2.07 kB

File Count

5

Publised On

07 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

17,809,504

Last day

-10.8%

25,006

Compared to previous day

Last week

-12.8%

112,961

Compared to previous week

Last month

15%

501,994

Compared to previous month

Last year

13.6%

5,948,110

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Installation

npm install --save @types/string-similarity

Summary

This package contains type definitions for string-similarity (https://github.com/aceakash/string-similarity#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/string-similarity.

index.d.ts

1export as namespace stringSimilarity;
2
3/**
4 * Returns a fraction between 0 and 1, which indicates the degree of similarity between the two strings.
5 * `0` indicates completely different strings, `1` indicates identical strings. The comparison is case-insensitive.
6 *
7 * @param string1 The first string
8 * @param string2 The second string
9 * @returns A fraction from 0 to 1, both inclusive. Higher number indicates more similarity.
10 */
11export function compareTwoStrings(string1: string, string2: string): number;
12
13/**
14 * Compares `mainString` against each string in `targetStrings`.
15 *
16 * @argument mainString: The string to match each target string against.
17 * @argument targetStrings: Each string in this array will be matched against the main string.
18 * @returns An object with a `ratings` property, which gives a similarity rating for each target string,
19 *          a `bestMatch` property, which specifies which target string was most similar to the main string,
20 *          and a `bestMatchIndex` property, which specifies the index of the `bestMatch` in the `targetStrings` array.
21 */
22export function findBestMatch(mainString: string, targetStrings: string[]): BestMatch;
23
24export interface Rating {
25    target: string;
26    rating: number;
27}
28export interface BestMatch {
29    ratings: Rating[];
30    bestMatch: Rating;
31    bestMatchIndex: number;
32}
33

Additional Details

Last updated: Tue, 07 Nov 2023 20:08:00 GMT
Dependencies: none

Credits

These definitions were written by ragtime, BendingBender, and Piotr Błażejewicz.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.9

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More