diff --git a/src/@awesome-cordova-plugins/plugins/file-md5/index.ts b/src/@awesome-cordova-plugins/plugins/file-md5/index.ts new file mode 100644 index 000000000..483870714 --- /dev/null +++ b/src/@awesome-cordova-plugins/plugins/file-md5/index.ts @@ -0,0 +1,43 @@ +import { Injectable } from '@angular/core'; +import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-plugins/core'; + +/** + * @name File MD5 + * @description + * This plugin reads large files in chunks and build the md5sum incrementally. + * @usage + * ```typescript + * import { FileMD5 } from '@awesome-cordova-plugins/file-md5/nx'; + * + * + * constructor(private fileMD5: FileMD5) { } + * + * ... + * + * + * this.fileMD5.file(fileEntry) + * .then((md5sum: string) => console.log(md5sum)) + * .catch((error: any) => console.error(error)); + * + * ``` + */ +@Plugin({ + pluginName: 'FileMD5', + plugin: 'cordova-plugin-file-md5', + pluginRef: 'md5chksum', + repo: 'https://github.com/mramonlopez/cordova-plugin-file-md5', + platforms: ['Android', 'iOS'], +}) +@Injectable() +export class FileMD5 extends AwesomeCordovaNativePlugin { + /** + * Get MD5 checksum from a file + * + * @param fileEntry {FileEntry} File entry is a org.apache.cordova.file.FileEntry + * @returns {Promise} Promise with md5sum + */ + @Cordova() + file(fileEntry: any): Promise { + return; + } +}