cordova-plugin-file-hash
Version:
Cordova FileHash Plugin
49 lines (32 loc) • 2.09 kB
Markdown
# cordova-plugin-file-hash
This plugin provides file hash functions
##Version 0.4.1
##Platforms
|**Android**|**IOS**|
|:---:|:---:|
|>=5.0|>= 8.0|
If your intrested i search help for an adaptation on Windows Phone(W10 ?), in that case leave a message [here](https://github.com/LordKBX/cordova-plugin-file-hash/issues)
###***list of functions***
|**md2**|**md5**|**sha1**|**sha256**|**sha384**|**sha512**|
|:---:|:---:|:---:|:---:|:---:|:---:|
###***functions usage***
[window.]FileHash.<function_name>(<file_absolute_path>, successCallback, errorCallback);
 require and absolute path(file:// format, use [cordova-plugin-file](https://www.npmjs.com/package/cordova-plugin-file) for retrieve the appfolder)
the successCallback function receive a JSON structure, here the content of the structure
Object{file: "<file_absolute_path>", algo: "<function_algorithm>", result: "<returned_file_hash>"}
the errorCallback function receive a JSON structure, here the content of the structure
Object{code: <int_return_code>, message: "<error_description>"}
###***List of error codes***
|code|message|additional informations|
|:---:|:---|:---|
|0|Execution Error|unknow error|
|1|Unknown Algorithm|-|
|2|File not found|on IOS was also send in case of access error|
|3|File access error|no sufficents access rights or already used file|
|4|Digest error|cryptography processing error|
###***Exemple on Android***
 this exemple use [cordova-plugin-file](https://www.npmjs.com/package/cordova-plugin-file) for retrieve the appfolder(cordova.file.applicationDirectory)
FileHash.md5(cordova.file.applicationDirectory+'www/index.html',function(e){console.log(e);}
Result
Object {file: "file:///android_asset/www/index.html", algo: "MD5", result: "5b8a987f7d13a5afa7bb86bb2b0eab90"}
> Written with [StackEdit](https://stackedit.io/).