Skip to content

Commit

Permalink
fix: npm configs
Browse files Browse the repository at this point in the history
  • Loading branch information
riderx committed Dec 15, 2022
1 parent 9e41edb commit 375ab2c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 15 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ Set Channel for this device
### addListener('download', ...)

```typescript
addListener(eventName: 'download', listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
addListener(eventName: "download", listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for download event in the App, let you know when the download is started, loading and finished
Expand All @@ -424,7 +424,7 @@ Listen for download event in the App, let you know when the download is started,
### addListener('noNeedUpdate', ...)

```typescript
addListener(eventName: 'noNeedUpdate', listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
addListener(eventName: "noNeedUpdate", listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for no need to update event, usefull when you want force check every time the app is launched
Expand All @@ -444,7 +444,7 @@ Listen for no need to update event, usefull when you want force check every time
### addListener('updateAvailable', ...)

```typescript
addListener(eventName: 'updateAvailable', listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle
addListener(eventName: "updateAvailable", listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for availbale update event, usefull when you want to force check every time the app is launched
Expand All @@ -464,7 +464,7 @@ Listen for availbale update event, usefull when you want to force check every ti
### addListener('downloadComplete', ...)

```typescript
addListener(eventName: 'downloadComplete', listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle
addListener(eventName: "downloadComplete", listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for download event in the App, let you know when the download is started, loading and finished
Expand All @@ -484,7 +484,7 @@ Listen for download event in the App, let you know when the download is started,
### addListener('majorAvailable', ...)

```typescript
addListener(eventName: 'majorAvailable', listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle
addListener(eventName: "majorAvailable", listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
Expand All @@ -504,7 +504,7 @@ Listen for Major update event in the App, let you know when major update is bloc
### addListener('updateFailed', ...)

```typescript
addListener(eventName: 'updateFailed', listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
addListener(eventName: "updateFailed", listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for update fail event in the App, let you know when update has fail to install at next app start
Expand All @@ -524,7 +524,7 @@ Listen for update fail event in the App, let you know when update has fail to in
### addListener('downloadFailed', ...)

```typescript
addListener(eventName: 'downloadFailed', listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
addListener(eventName: "downloadFailed", listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for download fail event in the App, let you know when download has fail finished
Expand All @@ -544,7 +544,7 @@ Listen for download fail event in the App, let you know when download has fail f
### addListener('appReloaded', ...)

```typescript
addListener(eventName: 'appReloaded', listenerFunc: AppReloadedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
addListener(eventName: "appReloaded", listenerFunc: AppReloadedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Listen for download fail event in the App, let you know when download has fail finished
Expand Down Expand Up @@ -629,16 +629,18 @@ Get the state of auto update config. This will return `false` in manual mode.
| **`version`** | <code>string</code> | Res of getLatest method | 4.0.0 |
| **`major`** | <code>boolean</code> | | |
| **`message`** | <code>string</code> | | |
| **`error`** | <code>string</code> | | |
| **`old`** | <code>string</code> | | |
| **`url`** | <code>string</code> | | |


#### channelRes

| Prop | Type | Description | Since |
| ------------ | ------------------- | ----------------------------- | ----- |
| **`status`** | <code>string</code> | Current status of set channel | 4.7.0 |
| **`error`** | <code>any</code> | | |
| Prop | Type | Description | Since |
| ------------- | ------------------- | ----------------------------- | ----- |
| **`status`** | <code>string</code> | Current status of set channel | 4.7.0 |
| **`error`** | <code>any</code> | | |
| **`message`** | <code>any</code> | | |


#### SetChannelOptions
Expand All @@ -654,6 +656,7 @@ Get the state of auto update config. This will return `false` in manual mode.
| -------------- | -------------------- | ----------------------------- | ----- |
| **`channel`** | <code>string</code> | Current status of get channel | 4.8.0 |
| **`error`** | <code>any</code> | | |
| **`message`** | <code>any</code> | | |
| **`status`** | <code>string</code> | | |
| **`allowSet`** | <code>boolean</code> | | |

Expand Down Expand Up @@ -727,12 +730,12 @@ Get the state of auto update config. This will return `false` in manual mode.

#### BundleStatus

<code>'success' | 'error' | 'pending' | 'downloading'</code>
<code>"success" | "error" | "pending" | "downloading"</code>


#### DelayUntilNext

<code>'background' | 'kill' | 'nativeVersion' | 'date'</code>
<code>"background" | "kill" | "nativeVersion" | "date"</code>


#### DownloadChangeListener
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"name": "@capgo/capacitor-updater",
"version": "4.14.3",
"packageManager": "pnpm@7.1.0",
"license": "LGPL-3.0-only",
"description": "OTA update for capacitor apps",
"description": "Live update for capacitor apps",
"main": "dist/plugin.cjs.js",
"module": "dist/esm/index.js",
"types": "dist/esm/index.d.ts",
Expand Down

0 comments on commit 375ab2c

Please sign in to comment.