github/awesome-cordova-plugins
github/awesome-cordova-plugins
3
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-04-09 16:43:19 +08:00
Code Issues Projects Releases Wiki Activity

docs(pro): add types for return values in deploy (#2292)

Browse Source
This commit is contained in:
Gustav Bylund 2018-06-23 17:14:03 +02:00 committed by Daniel Sogl
parent 15a334d87a
commit 1dc48e943c
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/@ionic-native/plugins/pro/index.ts
View File

@ -31,6 +31,8 @@ export interface DeployConfig {
channel?: string;
}
export type ProgressMessage = number | string;
/**
* @hidden
*/
@ -43,7 +45,7 @@ export class ProDeploy {
* @param config A valid Deploy config object
*/
@CordovaInstance()
init(config: DeployConfig): Promise<any> { return; }
init(config: DeployConfig): Promise<void> { return; }
/**
* Check a channel for an available update
@ -54,27 +56,27 @@ export class ProDeploy {
/**
* Download an available version
* @return {Observable<any>} Updates with percent completion, or errors with a message.
* @return {Observable<ProgressMessage>} Updates with percent completion, or errors with a message.
*/
@CordovaInstance({
observable: true
})
download(): Observable<any> { return; }
download(): Observable<ProgressMessage> { return; }
/**
* Unzip the latest downloaded version
* @return {Observable<any>} Updates with percent completion, or errors with a message.
* @return {Observable<ProgressMessage>} Updates with percent completion, or errors with a message.
*/
@CordovaInstance({
observable: true
})
extract(): Observable<any> { return; }
extract(): Observable<ProgressMessage> { return; }
/**
* Reload app with the deployed version
*/
@CordovaInstance()
redirect(): Promise<any> { return; }
redirect(): Promise<void> { return; }
/**
* Get info about the version running on the device
@ -87,14 +89,14 @@ export class ProDeploy {
* List versions stored on the device
*/
@CordovaInstance()
getVersions(): Promise<any> { return; }
getVersions(): Promise<string[]> { return; }
/**
* Delete a version stored on the device by UUID
* @param version A version UUID
*/
@CordovaInstance()
deleteVersion(version: string): Promise<any> { return; }
deleteVersion(version: string): Promise<void> { return; }
}
/**