Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/Cap-go/capacitor-downloader
Browse files Browse the repository at this point in the history
  • Loading branch information
@riderx
riderx committed Oct 25, 2024
2 parents 18e8fc9 + 1e14522 commit 55ee913
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 29 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [0.0.10](https://github.com/Cap-go/capacitor-downloader/compare/0.0.7...0.0.10) (2024-10-25)


### Features

* add package lock ios ([27e238f](https://github.com/Cap-go/capacitor-downloader/commit/27e238f1461b68381851103f58edc888c0344ac8))


### Bug Fixes

* add android and ios cache ([e4ea1da](https://github.com/Cap-go/capacitor-downloader/commit/e4ea1dad4e3bb7f6a405fdb87109c973ea6b249c))
* artefact issue ([c84c0b4](https://github.com/Cap-go/capacitor-downloader/commit/c84c0b4532cedc05481c648afff8052c2c326c92))
* deps issue ([7e91427](https://github.com/Cap-go/capacitor-downloader/commit/7e91427829473de5b41b3c400391e28563ae30ba))
* github push ([cd82789](https://github.com/Cap-go/capacitor-downloader/commit/cd82789cc9d05d9d1e98cbd4b6fd77b9029fc7f8))
* issues push ([15ceaf6](https://github.com/Cap-go/capacitor-downloader/commit/15ceaf68116cacde5efff7192105d956486d7267))
* publish ([b105567](https://github.com/Cap-go/capacitor-downloader/commit/b10556707c8233a38e79ff239bf20a05b76805d0))
* publish ([fa3a091](https://github.com/Cap-go/capacitor-downloader/commit/fa3a09140434d3a262ab15981e181e80e613b970))
* publish to repo ([05e897c](https://github.com/Cap-go/capacitor-downloader/commit/05e897cc7e5277c498788307a65ebed4b9ae8c54))
* try correct push ([0bc5439](https://github.com/Cap-go/capacitor-downloader/commit/0bc54395953c9b6ae982c527f1c69ebe0c1bbbea))
* try new build and bumb system ([192367c](https://github.com/Cap-go/capacitor-downloader/commit/192367c47fe4b76fc552e78aaca42181dab19240))
* updates versions ([79ac707](https://github.com/Cap-go/capacitor-downloader/commit/79ac7078da8a8c633c7f61fc1f96d3dac5881df2))
* use better cache ([8bfaa5c](https://github.com/Cap-go/capacitor-downloader/commit/8bfaa5c8e1adbfd8c2b86fc99fa5d97842b52330))
* use cache v4 ([da7b4f1](https://github.com/Cap-go/capacitor-downloader/commit/da7b4f1fb7f6b2aa3982bec1029f6f77ec4f407a))

### [0.0.9](https://github.com/Cap-go/capacitor-downloader/compare/0.0.7...0.0.9) (2024-10-25)


Expand Down
64 changes: 36 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,156 +42,155 @@ npx cap sync
### download(...)

```typescript
download(options: DownloadOptions) => Promise<DownloadTask>
download(options: DownloadOptions) => any
```

| Param | Type |
| ------------- | ----------------------------------------------------------- |
| **`options`** | <code><a href="#downloadoptions">DownloadOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#downloadtask">DownloadTask</a>&gt;</code>
**Returns:** <code>any</code>

--------------------


### pause(...)

```typescript
pause(id: string) => Promise<void>
pause(id: string) => any
```

| Param | Type |
| -------- | ------------------- |
| **`id`** | <code>string</code> |

**Returns:** <code>any</code>

--------------------


### resume(...)

```typescript
resume(id: string) => Promise<void>
resume(id: string) => any
```

| Param | Type |
| -------- | ------------------- |
| **`id`** | <code>string</code> |

**Returns:** <code>any</code>

--------------------


### stop(...)

```typescript
stop(id: string) => Promise<void>
stop(id: string) => any
```

| Param | Type |
| -------- | ------------------- |
| **`id`** | <code>string</code> |

**Returns:** <code>any</code>

--------------------


### checkStatus(...)

```typescript
checkStatus(id: string) => Promise<DownloadTask>
checkStatus(id: string) => any
```

| Param | Type |
| -------- | ------------------- |
| **`id`** | <code>string</code> |

**Returns:** <code>Promise&lt;<a href="#downloadtask">DownloadTask</a>&gt;</code>
**Returns:** <code>any</code>

--------------------


### getFileInfo(...)

```typescript
getFileInfo(path: string) => Promise<{ size: number; type: string; }>
getFileInfo(path: string) => any
```

| Param | Type |
| ---------- | ------------------- |
| **`path`** | <code>string</code> |

**Returns:** <code>Promise&lt;{ size: number; type: string; }&gt;</code>
**Returns:** <code>any</code>

--------------------


### addListener('downloadProgress', ...)

```typescript
addListener(eventName: 'downloadProgress', listenerFunc: (progress: { id: string; progress: number; }) => void) => Promise<PluginListenerHandle>
addListener(eventName: 'downloadProgress', listenerFunc: (progress: { id: string; progress: number; }) => void) => any
```

| Param | Type |
| ------------------ | --------------------------------------------------------------------- |
| **`eventName`** | <code>'downloadProgress'</code> |
| **`listenerFunc`** | <code>(progress: { id: string; progress: number; }) =&gt; void</code> |

**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
**Returns:** <code>any</code>

--------------------


### addListener('downloadCompleted', ...)

```typescript
addListener(eventName: 'downloadCompleted', listenerFunc: (result: { id: string; }) => void) => Promise<PluginListenerHandle>
addListener(eventName: 'downloadCompleted', listenerFunc: (result: { id: string; }) => void) => any
```

| Param | Type |
| ------------------ | ------------------------------------------------- |
| **`eventName`** | <code>'downloadCompleted'</code> |
| **`listenerFunc`** | <code>(result: { id: string; }) =&gt; void</code> |

**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
**Returns:** <code>any</code>

--------------------


### addListener('downloadFailed', ...)

```typescript
addListener(eventName: 'downloadFailed', listenerFunc: (error: { id: string; error: string; }) => void) => Promise<PluginListenerHandle>
addListener(eventName: 'downloadFailed', listenerFunc: (error: { id: string; error: string; }) => void) => any
```

| Param | Type |
| ------------------ | --------------------------------------------------------------- |
| **`eventName`** | <code>'downloadFailed'</code> |
| **`listenerFunc`** | <code>(error: { id: string; error: string; }) =&gt; void</code> |

**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
**Returns:** <code>any</code>

--------------------


### removeAllListeners()

```typescript
removeAllListeners() => Promise<void>
removeAllListeners() => any
```

**Returns:** <code>any</code>

--------------------


### Interfaces


#### DownloadTask

| Prop | Type |
| -------------- | -------------------------------------------------------------------- |
| **`id`** | <code>string</code> |
| **`progress`** | <code>number</code> |
| **`state`** | <code>'PENDING' \| 'RUNNING' \| 'PAUSED' \| 'DONE' \| 'ERROR'</code> |


#### DownloadOptions

| Prop | Type |
Expand All @@ -204,11 +203,20 @@ removeAllListeners() => Promise<void>
| **`priority`** | <code>'high' \| 'normal' \| 'low'</code> |


#### DownloadTask

| Prop | Type |
| -------------- | -------------------------------------------------------------------- |
| **`id`** | <code>string</code> |
| **`progress`** | <code>number</code> |
| **`state`** | <code>'PENDING' \| 'RUNNING' \| 'PAUSED' \| 'DONE' \| 'ERROR'</code> |


#### PluginListenerHandle

| Prop | Type |
| ------------ | ----------------------------------------- |
| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
| Prop | Type |
| ------------ | ------------------------- |
| **`remove`** | <code>() =&gt; any</code> |

</docgen-api>

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@capgo/capacitor-downloader",
"version": "0.0.9",
"version": "0.0.10",
"description": "Download file in background or foreground",
"main": "dist/plugin.cjs.js",
"module": "dist/esm/index.js",
Expand Down

0 comments on commit 55ee913

Please sign in to comment.