Merge pull request #276 from vunyunt/master

Add RNFetchblob.fs.hash function to type definition
joltup · Sep 26, 2019 · 6e2234b · 6e2234b
2 parents eff4ae1 + b48f0e7
commit 6e2234b
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -294,6 +294,7 @@ export interface Net {
     removeCookies(domain?: string): Promise<null>;
 }
 
+type HashAlgorithm = "md5" | "sha1" | "sha224" | "sha256" | "sha384" | "sha512";
 export interface FS {
     RNFetchBlobSession: RNFetchBlobSession;
 
@@ -317,6 +318,14 @@ export interface FS {
 
     ls(path: string): Promise<string[]>;
 
+    /**
+     * Read the file from the given path and calculate a cryptographic hash sum over its contents.
+     *
+     * @param path Path to the file
+     * @param algorithm The hash algorithm to use
+     */
+    hash(path: string, algorithm: HashAlgorithm): Promise<string>;
+
     /**
      * Create file stream from file at `path`.
      * @param  path   The file path.