Skip to content

Commit

Permalink
feat(file-md5): add plugin (#4201)
Browse files Browse the repository at this point in the history
* added cordova-plugin-file-md5

* Update index.ts

Co-authored-by: Daniel Sogl <daniel@sogls.de>
  • Loading branch information
vmartins and danielsogl committed Jun 30, 2022
1 parent 032f3a1 commit 63c8365
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions 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<any>} Promise with md5sum
*/
@Cordova()
file(fileEntry: any): Promise<any> {
return;
}
}

0 comments on commit 63c8365

Please sign in to comment.