fast-ssdeep
v1.0.2
Published
Node.js binding for the ssdeep CTPH library
Downloads
48
Readme
fast-ssdeep
Node.js binding for the ssdeep CTPH library.
Installation
Install the fast-ssdeep package from the NPM registry using your package manager of choice.
Example:
npm install fast-ssdeep
# or
yarn add fast-ssdeep
# or
pnpm install fast-ssdeep
Documentation
ssdeep.hash(contents: string|Buffer): Promise<string>
Asynchronously calculate an ssdeep hash based on the contents
argument, which can be a string or Buffer.
ssdeep.hashSync(contents: string|Buffer): string
Synchronously calculate an ssdeep hash based on the contents
argument, which can be a string or Buffer.
ssdeep.compare(hash1: string, hash2: string): Promise<number>
Asynchronously compare two ssdeep hashes to generate a similarity score. Both hashes must be passed as strings, and a similarity between 0-100 will be returned.
ssdeep.compareSync(hash1: string, hash2: string): number
Synchronously compare two ssdeep hashes to generate a similarity score. Both hashes must be passed as strings, and a similarity between 0-100 will be returned.