Installations

npm install cos-similarity

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

20.11.0

NPM Version

10.6.0 Pull Requests

Open

0

Total

13

Closed

0

Merged

13

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

rtomrud

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

7 Stars

95 Commits

2 Watchers

1 Branches

2 Contributors

Updated on Aug 12, 2024

Maintainers

1

View All 2 Contributors

Package Meta Information

Latest Version

2.0.0

Package Id

cos-similarity@2.0.0

Unpacked Size

4.53 kB

Size

2.08 kB

File Count

5

NPM Version

10.6.0

Node Version

20.11.0

Published on

Apr 30, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

7

@eslint/js compute-cosine-similarity cosine-similarity cosine-similarity-threshold eslint mitata prettier

cos-similarity

Computes the cosine similarity between two vectors

Installing

1npm install cos-similarity

API

`cosSimilarity(vectorA, vectorB)`

Returns the cosine similarity between the given vectorA and vectorB. Returns 0 when given a zero vector, [], undefined or nothing.

1import cosSimilarity from "cos-similarity";
2
3cosSimilarity([1, 2, 4], [1, 0, 2]); // -> 0.8783100656536799
4cosSimilarity([1, 2, 0], [1, 2, 0]); // -> 1
5cosSimilarity([2, 0, 0], [0, 2, 0]); // -> 0
6cosSimilarity([-1, -2, 0], [1, 2, 0]); // -> -1

Benchmark

To run the benchmark, clone the repositry and run the bench script:

1npm run bench

benchmark                        time (avg)             (min … max)
-------------------------------------------------------------------
• cosine similarity modules
-------------------------------------------------------------------
cos-similarity                  249 ns/iter       (247 ns … 319 ns)
compute-cosine-similarity       854 ns/iter       (829 ns … 428 µs)
cosine-similarity            14'251 ns/iter    (13'680 ns … 229 µs)
cosine-similarity-threshold     879 ns/iter       (802 ns … 310 µs)

summary for cosine similarity modules
  cos-similarity
   3.43x faster than compute-cosine-similarity
   3.53x faster than cosine-similarity-threshold
   57.25x faster than cosine-similarity

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

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

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

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

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2025-07-07

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