Skip to content

Feat/support idb paths #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xitronix wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Feat/support idb paths #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38fa4b7
feat(web): support idb paths
xitronix Feb 18, 2025
5bf633a
feat: update documentation
xitronix Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ This plugin provides a flexible way to upload natively files to various servers,

Can be used in combination with the [Capacitor Camera preview](https://github.com/Cap-go/camera-preview) To upload file in reliable manner instead of reading them in buffer of webview and then upload in JS.

On the web, file paths support IndexedDB (IDB) semantic paths using the following format:
`idb://[database-name]/[collection-name]/[key]`
This allows seamless integration with IndexedDB for storing and retrieving files.

## Install

```bash
Expand All @@ -29,9 +33,6 @@ Add the following to your `AndroidManifest.xml` file:
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
```

## Exemple S3 upload:


## Example S3 upload:

```typescript
Expand Down Expand Up @@ -67,7 +68,7 @@ async function uploadToS3(filePath: string, presignedUrl: string, fields: Record

```

### Exemple upload to a custom server:
### Example upload to a custom server:

```typescript
import { Uploader } from '@capgo/capacitor-uploader';
Expand Down Expand Up @@ -118,12 +119,13 @@ async function uploadToCustomServer(filePath: string, serverUrl: string) {

// Usage
const filePath = 'file:///path/to/your/file.jpg';

const serverUrl = 'https://your-custom-server.com/upload';
uploadToCustomServer(filePath, serverUrl);

```

### Exemple with Capacitor Camera preview:
### Example with Capacitor Camera preview:

Documentation for the [Capacitor Camera preview](https://github.com/Cap-go/camera-preview)

Expand Down
Loading