improve(docs): add typescript typings

Author: memcorrupt

index.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="node" />
+
+/**
+ * Generate ssdeep hash asynchronously.
+ * @param contents The data to hash.
+ * @returns A promise to be resolved with the resulting hash.
+ * @throws {TypeError} When the input is malformed.
+ */
+export declare function hash(contents: string | Buffer) : Promise<string>;
+
+/**
+ * Generate ssdeep hash synchronously.
+ * @param contents The data to hash.
+ * @returns The resulting hash.
+ * @throws {TypeError} When the input is malformed.
+ */
+export declare function hashSync(contents: string | Buffer) : string;
+
+/**
+ * Compare ssdeep hashes asynchronously.
+ * @param hash1 The first hash to compare.
+ * @param hash2 The second hash to compare.
+ * @returns A promise to be resolved with the similarity score for the input hashes, between 0-100.
+ * @throws {TypeError} When the hashes are malformed.
+ */
+export declare function compare(hash1: string, hash2: string): Promise<number>;
+
+/**
+ * Compare ssdeep hashes synchronously.
+ * @param hash1 The first hash to compare.
+ * @param hash2 The second hash to compare.
+ * @returns The similarity score for the input hashes, between 0-100.
+ * @throws {TypeError} When the hashes are malformed.
+ */
+export declare function compareSync(hash1: string, hash2: string): number;

package.json

@@ -1,8 +1,9 @@
 {
   "name": "fast-ssdeep",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Node.js binding for the ssdeep CTPH library",
   "main": "index.js",
+  "types": "index.d.ts",
   "engines": {
     "node": ">= 10.0.0"
   },
@@ -20,6 +21,7 @@
     "ssdeep/edit_dist.h",
     "ssdeep/sum_table.h",
     "index.js",
+    "index.d.ts",
     "binding.gyp"
   ],
   "repository": {

test/ssdeep_test.js

@@ -1,6 +1,6 @@
 const assert = require("assert");
 const { describe, it } = require("mocha");
-const ssdeep = require('bindings')('fast-ssdeep.node');
+const ssdeep = require("../");
 
 describe("should generate correct hashes", function(){
     const hashes = {