@capgo/capacitor-updater

v7.33.0

Published

a day ago

Live update for capacitor apps

Downloads

153,188

0High
0Medium
0Low

riderx

capacitor live updates live update updates auto update manual update capgo plugin OTA ionic appflow alternative capawesome alternative native

Capacitor updater

Capacitor plugin to update your app remotely in real-time.

Open-source Alternative to Appflow, Codepush or Capawesome

Why Capacitor Updater?

App store review processes can take days or weeks, blocking critical bug fixes and updates from reaching your users. Capacitor Updater solves this by:

Instant updates - Push JavaScript/HTML/CSS updates directly to users without app store review
Delta updates - Only download changed files, making updates ultra-fast
Rollback protection - Automatically revert broken updates to keep your app stable
Open source - Self-host or use Capgo Cloud, with full control over your update infrastructure
Battle-tested - Used by 3000+ production apps with proven reliability
Most stared - Capacitor updater is the most stared Capacitor plugin on GitHub

Perfect for fixing bugs immediately, A/B testing features, and maintaining control over your release schedule.

Features

☁️ Cloud / Self hosted Support: Use our Cloud to manage your app updates or yours.
📦 Bundle Management: Download, assign to channel, rollback.
📺 Channel Support: Use channels to manage different environments.
🎯 Set Channel to specific device to do QA or debug one user.
🔄 Auto Update: Automatically download and set the latest bundle for the app.
🛟 Rollback: Reset the app to last working bundle if an incompatible bundle has been set.
🔁 Delta Updates: Make instant updates by only downloading changed files.
🔒 Security: Encrypt and sign each updates with best in class security standards.
⚔️ Battle-Tested: Used in more than 3000 projects.
📊 View your deployment statistics
🔋 Supports Android and iOS
⚡️ Capacitor 6/7 support
🌐 Open Source: Licensed under the Mozilla Public License 2.0
🌐 Open Source Backend: Self install our backend in your infra

You have 3 ways possible :

Use capgo.app a full featured auto-update system in 5 min Setup, to manage version, update, revert and see stats.
Use your own server update with auto-update system
Use manual methods to zip, upload, download, from JS to do it when you want.

Documentation

The most complete documentation here.

Community

Join the discord to get help.

Migration to v7

privateKey is not available anymore, it was used for the old encryption method. to migrate follow this guide : https://capgo.app/docs/plugin/cloud-mode/getting-started/
To capacitor v7 : https://capacitorjs.com/docs/updating/7-0

Compatibility

| Plugin version | Capacitor compatibility | Maintained | | -------------- | ----------------------- | ----------------- | | v7.*.* | v7.*.* | ✅ | | v6.*.* | v6.*.* | ✅ | | v5.*.* | v5.*.* | ⚠️ Deprecated | | v4.*.* | v4.*.* | ⚠️ Deprecated | | v3.*.* | v3.*.* | ⚠️ Deprecated | | > 7 | v4.*.* | ⚠️ Deprecated, our CI got crazy and bumped too much version |

iOS

Privacy manifest

Add the NSPrivacyAccessedAPICategoryUserDefaults dictionary key to your Privacy Manifest (usually ios/App/PrivacyInfo.xcprivacy):

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>NSPrivacyAccessedAPITypes</key>
    <array>
      <!-- Add this dict entry to the array if the file already exists. -->
      <dict>
        <key>NSPrivacyAccessedAPIType</key>
        <string>NSPrivacyAccessedAPICategoryUserDefaults</string>
        <key>NSPrivacyAccessedAPITypeReasons</key>
        <array>
          <string>CA92.1</string>
        </array>
      </dict>
    </array>
  </dict>
</plist>

We recommend to declare CA92.1 as the reason for accessing the UserDefaults API.

Installation

Step by step here: Getting started

npm install @capgo/capacitor-updater
npx cap sync

Auto-update setup

Create your account in capgo.app and get your API key

For detailed instructions on the auto-update setup, refer to the Auto update documentation.

No Cloud setup

Download update distribution zipfiles from a custom URL. Manually control the entire update process.

Edit your capacitor.config.json like below, set autoUpdate to false.

// capacitor.config.json
{
	"appId": "**.***.**",
	"appName": "Name",
	"plugins": {
		"CapacitorUpdater": {
			"autoUpdate": false,
		}
	}
}

Add to your main code

  import { CapacitorUpdater } from '@capgo/capacitor-updater'
  CapacitorUpdater.notifyAppReady()

This informs Capacitor Updater that the current update bundle has loaded successfully. Failing to call this method will cause your application to be rolled back to the previously successful version (or built-in bundle).

Add this to your application.

  const version = await CapacitorUpdater.download({
    version: '0.0.4',
    url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',
  })
  await CapacitorUpdater.set(version); // sets the new version, and reloads the app

Failed updates will automatically roll back to the last successful version.
Example: Using App-state to control updates, with SplashScreen: You might also consider performing auto-update when application state changes, and using the Splash Screen to improve user experience.

  import { CapacitorUpdater, VersionInfo } from '@capgo/capacitor-updater'
  import { SplashScreen } from '@capacitor/splash-screen'
  import { App } from '@capacitor/app'

  let version: VersionInfo;
  App.addListener('appStateChange', async (state) => {
      if (state.isActive) {
        // Ensure download occurs while the app is active, or download may fail
        version = await CapacitorUpdater.download({
          version: '0.0.4',
          url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',
        })
      }

      if (!state.isActive && version) {
        // Activate the update when the application is sent to background
        SplashScreen.show()
        try {
          await CapacitorUpdater.set(version);
          // At this point, the new version should be active, and will need to hide the splash screen
        } catch () {
          SplashScreen.hide() // Hide the splash screen again if something went wrong
        }
      }
  })

TIP: If you prefer a secure and automated way to update your app, you can use capgo.app - a full-featured, auto-update system.

Store Guideline Compliance

Android Google Play and iOS App Store have corresponding guidelines that have rules you should be aware of before integrating the Capacitor-updater solution within your application.

Google play

Third paragraph of Device and Network Abuse topic describe that updating source code by any method besides Google Play's update mechanism is restricted. But this restriction does not apply to updating JavaScript bundles.

This restriction does not apply to code that runs in a virtual machine and has limited access to Android APIs (such as JavaScript in a web view or browser).

That fully allow Capacitor-updater as it updates just JS bundles and can't update native code part.

App Store

Paragraph 3.3.2, since back in 2015's Apple Developer Program License Agreement fully allowed performing over-the-air updates of JavaScript and assets.

And in its latest version (20170605) downloadable here this ruling is even broader:

Interpreted code may be downloaded to an Application, but only so long as such code:

(a) does not change the primary purpose of the Application by providing features or functionality that are inconsistent with the intended and advertised purpose of the Application as submitted to the App Store
(b) does not create a store or storefront for other code or applications
(c) does not bypass signing, sandbox, or other security features of the OS.

Capacitor-updater allows you to respect these rules in full compliance, so long as the update you push does not significantly deviate your product from its original App Store approved intent.

To further remain in compliance with Apple's guidelines, we suggest that App Store-distributed apps don't enable the Force update scenario, since in the App Store Review Guidelines it is written that:

Apps must not force users to rate the app, review the app, download other apps, or other similar actions to access functionality, content, or use of the app.

This is not a problem for the default behavior of background update, since it won't force the user to apply the new version until the next app close, but at least you should be aware of that ruling if you decide to show it.

Packaging `dist.zip` update bundles

Capacitor Updater works by unzipping a compiled app bundle to the native device filesystem. Whatever you choose to name the file you upload/download from your release/update server URL (via either manual or automatic updating), this .zip bundle must meet the following requirements:

The zip file should contain the full contents of your production Capacitor build output folder, usually {project directory}/dist/ or {project directory}/www/. This is where index.html will be located, and it should also contain all bundled JavaScript, CSS, and web resources necessary for your app to run.
Do not password encrypt the bundle zip file, or it will fail to unpack.
Make sure the bundle does not contain any extra hidden files or folders, or it may fail to unpack.

Updater Plugin Config

CapacitorUpdater can be configured with these options:

| Prop | Type | ----------------------------- | ------------ | appReadyTimeout | responseTimeout | autoDeleteFailed | autoDeletePrevious | autoUpdate | resetWhenUpdate | updateUrl | channelUrl | statsUrl | publicKey | version | directUpdate | autoSplashscreen | autoSplashscreenLoader | autoSplashscreenTimeout | periodCheckDelay | localS3 | localHost | localWebHost | localSupa | localSupaAnon | localApi | localApiFiles | allowModifyUrl | allowModifyAppId | allowManualBundleError | persistCustomId | persistModifyUrl | defaultChannel | appId | keepUrlPathAfterReload | disableJSLogging | shakeMenu | Description | Default | Since | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ------- | | number | Configure the number of milliseconds the native plugin should wait before considering an update 'failed'. Only available for Android and iOS. | 10000 // (10 seconds) | | | number | Configure the number of seconds the native plugin should wait before considering API timeout. Only available for Android and iOS. | 20 // (20 second) | | | boolean | Configure whether the plugin should use automatically delete failed bundles. Only available for Android and iOS. | true | | | boolean | Configure whether the plugin should use automatically delete previous bundles after a successful update. Only available for Android and iOS. | true | | | boolean | Configure whether the plugin should use Auto Update via an update server. Only available for Android and iOS. | true | | | boolean | Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device. Only available for Android and iOS. | true | | | string | Configure the URL / endpoint to which update checks are sent. Only available for Android and iOS. | https://plugin.capgo.app/updates | | | string | Configure the URL / endpoint for channel operations. Only available for Android and iOS. | https://plugin.capgo.app/channel_self | | | string | Configure the URL / endpoint to which update statistics are sent. Only available for Android and iOS. Set to "" to disable stats reporting. | https://plugin.capgo.app/stats | | | string | Configure the public key for end to end live update encryption Version 2 Only available for Android and iOS. | undefined | 6.2.0 | | string | Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code. Only available for Android and iOS. | undefined | 4.17.48 | | boolean | 'always' | 'atInstall' | 'onLaunch' | Configure when the plugin should direct install updates. Only for autoUpdate mode. Works well for apps less than 10MB and with uploads done using --partial flag. Zip or apps more than 10MB will be relatively slow for users to update. - false: Never do direct updates (use default behavior: download at start, set when backgrounded) - atInstall: Direct update only when app is installed, updated from store, otherwise act as directUpdate = false - onLaunch: Direct update only on app installed, updated from store or after app kill, otherwise act as directUpdate = false - always: Direct update in all previous cases (app installed, updated from store, after app kill or app resume), never act as directUpdate = false - true: (deprecated) Same as "always" for backward compatibility Only available for Android and iOS. | false | 5.1.0 | | boolean | Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed. This removes the need to manually listen for appReady events and call SplashScreen.hide(). Only works when directUpdate is set to "atInstall", "always", "onLaunch", or true. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires autoUpdate and directUpdate to be enabled. Only available for Android and iOS. | false | 7.6.0 | | boolean | Display a native loading indicator on top of the splashscreen while automatic direct updates are running. Only takes effect when {@link autoSplashscreen} is enabled. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Only available for Android and iOS. | false | 7.19.0 | | number | Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates. If the timeout elapses, the update continues to download in the background while the splashscreen is dismissed. Set to 0 (zero) to disable the timeout. When the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch. Requires {@link autoSplashscreen} to be enabled. Only available for Android and iOS. | 10000 // (10 seconds) | 7.19.0 | | number | Configure the delay period for period update check. the unit is in seconds. Only available for Android and iOS. Cannot be less than 600 seconds (10 minutes). | 0 (disabled) | | | boolean | Configure the CLI to use a local server for testing or self-hosted update server. | undefined | 4.17.48 | | string | Configure the CLI to use a local server for testing or self-hosted update server. | undefined | 4.17.48 | | string | Configure the CLI to use a local server for testing or self-hosted update server. | undefined | 4.17.48 | | string | Configure the CLI to use a local server for testing or self-hosted update server. | undefined | 4.17.48 | | string | Configure the CLI to use a local server for testing. | undefined | 4.17.48 | | string | Configure the CLI to use a local api for testing. | undefined | 6.3.3 | | string | Configure the CLI to use a local file api for testing. | undefined | 6.3.3 | | boolean | Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side. | false | 5.4.0 | | boolean | Allow the plugin to modify the appId dynamically from the JavaScript side. | false | 7.14.0 | | boolean | Allow marking bundles as errored from JavaScript while using manual update flows. When enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to error. | false | 7.20.0 | | boolean | Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts. Only available for Android and iOS. | false (will be true by default in a future major release v8.x.x) | 7.17.3 | | boolean | Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl}, {@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts. Only available for Android and iOS. | false | 7.20.0 | | string | Set the default channel for the app in the config. Case sensitive. This will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud. This requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options | undefined | 5.5.0 | | string | Configure the app id for the app in the config. | undefined | 6.0.0 | | boolean | Configure the plugin to keep the URL path after a reload. WARNING: When a reload is triggered, 'window.history' will be cleared. | false | 6.8.0 | | boolean | Disable the JavaScript logging of the plugin. if true, the plugin will not log to the JavaScript console. only the native log will be done | false | 7.3.0 | | boolean | Enable shake gesture to show update menu for debugging/testing purposes | false | 7.5.0 |

Examples

In capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": false,
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "autoSplashscreenLoader": undefined,
      "autoSplashscreenTimeout": undefined,
      "periodCheckDelay": 3600 (1 hour),
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "allowModifyAppId": undefined,
      "allowManualBundleError": undefined,
      "persistCustomId": undefined,
      "persistModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

In capacitor.config.ts:

/// <reference types="@capgo/capacitor-updater" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: false,
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      autoSplashscreenLoader: undefined,
      autoSplashscreenTimeout: undefined,
      periodCheckDelay: 3600 (1 hour),
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      allowModifyAppId: undefined,
      allowManualBundleError: undefined,
      persistCustomId: undefined,
      persistModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

API

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notify the native layer that JavaScript initialized successfully.

CRITICAL: You must call this method on every app launch to prevent automatic rollback.

This is a simple notification to confirm that your bundle's JavaScript loaded and executed. The native web server successfully served the bundle files and your JS runtime started. That's all it checks - nothing more complex.

What triggers rollback:

NOT calling this method within the timeout (default: 10 seconds)
Complete JavaScript failure (bundle won't load at all)

What does NOT trigger rollback:

Runtime errors after initialization (API failures, crashes, etc.)
Network request failures
Application logic errors

IMPORTANT: Call this BEFORE any network requests. Don't wait for APIs, data loading, or async operations. Call it as soon as your JavaScript bundle starts executing to confirm the bundle itself is valid.

Best practices:

Call immediately in your app entry point (main.js, app component mount, etc.)
Don't put it after network calls or heavy initialization
Don't wrap it in try/catch with conditions
Adjust {@link PluginsConfig.CapacitorUpdater.appReadyTimeout} if you need more time

Returns: Promise<AppReadyResult>

setUpdateUrl(...)

setUpdateUrl(options: UpdateUrl) => Promise<void>

Set the update URL for the app dynamically at runtime.

This overrides the {@link PluginsConfig.CapacitorUpdater.updateUrl} config value. Requires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to true.

Use {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts. Otherwise, the URL will reset to the config value on next app launch.

| Param | Type | Description | | ------------- | ----------------------------------------------- | ------------------------------------------------- | | options | UpdateUrl | Contains the URL to use for checking for updates. |

Since: 5.4.0

setStatsUrl(...)

setStatsUrl(options: StatsUrl) => Promise<void>

Set the statistics URL for the app dynamically at runtime.

This overrides the {@link PluginsConfig.CapacitorUpdater.statsUrl} config value. Requires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to true.

Pass an empty string to disable statistics gathering entirely. Use {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.

| Param | Type | Description | | ------------- | --------------------------------------------- | ------------------------------------------------------------------------------ | | options | StatsUrl | Contains the URL to use for sending statistics, or an empty string to disable. |

Since: 5.4.0

setChannelUrl(...)

setChannelUrl(options: ChannelUrl) => Promise<void>

Set the channel URL for the app dynamically at runtime.

This overrides the {@link PluginsConfig.CapacitorUpdater.channelUrl} config value. Requires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to true.

Use {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts. Otherwise, the URL will reset to the config value on next app launch.

| Param | Type | Description | | ------------- | ------------------------------------------------- | ----------------------------------------------- | | options | ChannelUrl | Contains the URL to use for channel operations. |

Since: 5.4.0

download(...)

download(options: DownloadOptions) => Promise<BundleInfo>

Download a new bundle from the provided URL for later installation.

The downloaded bundle is stored locally but not activated. To use it:

Call {@link next} to set it for installation on next app backgrounding/restart
Call {@link set} to activate it immediately (destroys current JavaScript context)

The URL should point to a zip file containing either:

Your app files directly in the zip root, or
A single folder containing all your app files

The bundle must include an index.html file at the root level.

For encrypted bundles, provide the sessionKey and checksum parameters. For multi-file partial updates, provide the manifest array.

| Param | Type | Description | | ------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | options | DownloadOptions | The {@link DownloadOptions} for downloading a new bundle zip. |

Returns: Promise<BundleInfo>

next(...)

next(options: BundleId) => Promise<BundleInfo>

Set the next bundle to be activated when the app backgrounds or restarts.

This is the recommended way to apply updates as it doesn't interrupt the user's current session. The bundle will be activated when:

The app is backgrounded (user switches away), or
The app is killed and relaunched, or
{@link reload} is called manually

Unlike {@link set}, this method does NOT destroy the current JavaScript context immediately. Your app continues running normally until one of the above events occurs.

Use {@link setMultiDelay} to add additional conditions before the update is applied.

| Param | Type | Description | | ------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | options | BundleId | Contains the ID of the bundle to set as next. Use {@link BundleInfo.id} from a downloaded bundle. |

Returns: Promise<BundleInfo>

set(...)

set(options: BundleId) => Promise<void>

Set the current bundle and immediately reloads the app.

IMPORTANT: This is a terminal operation that destroys the current JavaScript context.

When you call this method:

The entire JavaScript context is immediately destroyed
The app reloads from a different folder with different files
NO code after this call will execute
NO promises will resolve
NO callbacks will fire
Event listeners registered after this call are unreliable and may never fire

The reload happens automatically - you don't need to do anything else. If you need to preserve state like the current URL path, use the {@link PluginsConfig.CapacitorUpdater.keepUrlPathAfterReload} config option. For other state preservation needs, save your data before calling this method (e.g., to localStorage).

Do not try to execute additional logic after calling set() - it won't work as expected.

| Param | Type | Description | | ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------- | | options | BundleId | A {@link BundleId} object containing the new bundle id to set as current. |

delete(...)

delete(options: BundleId) => Promise<void>

Delete a bundle from local storage to free up disk space.

You cannot delete:

The currently active bundle
The builtin bundle (the version shipped with your app)
The bundle set as next (call {@link next} with a different bundle first)

Use {@link list} to get all available bundle IDs.

Note: The bundle ID is NOT the same as the version name. Use the id field from {@link BundleInfo}, not the version field.

| Param | Type | Description | | ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------- | | options | BundleId | A {@link BundleId} object containing the bundle ID to delete. |

setBundleError(...)

setBundleError(options: BundleId) => Promise<BundleInfo>

Manually mark a bundle as failed/errored in manual update mode.

This is useful when you detect that a bundle has critical issues and want to prevent it from being used again. The bundle status will be changed to error and the plugin will avoid using this bundle in the future.

Requirements:

{@link PluginsConfig.CapacitorUpdater.allowManualBundleError} must be set to true
Only works in manual update mode (when autoUpdate is disabled)

Common use case: After downloading and testing a bundle, you discover it has critical bugs and want to mark it as failed so it won't be retried.

| Param | Type | Description | | ------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------- | | options | BundleId | A {@link BundleId} object containing the bundle ID to mark as errored. |

Returns: Promise<BundleInfo>

Since: 7.20.0

list(...)

list(options?: ListOptions | undefined) => Promise<BundleListResult>

Get all locally downloaded bundles stored in your app.

This returns all bundles that have been downloaded and are available locally, including:

The currently active bundle
The builtin bundle (shipped with your app)
Any downloaded bundles waiting to be activated
Failed bundles (with error status)

Use this to:

Check available disk space by counting bundles
Delete old bundles with {@link delete}
Monitor bundle download status

| Param | Type | Description | | ------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------ | | options | ListOptio

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Capacitor updater

Why Capacitor Updater?

Features

Documentation

Community

Migration to v7

Compatibility

iOS

Privacy manifest

Installation

Auto-update setup

No Cloud setup

Store Guideline Compliance

Google play

App Store

Packaging dist.zip update bundles

Updater Plugin Config

Examples

API

notifyAppReady()

setUpdateUrl(...)

setStatsUrl(...)

setChannelUrl(...)

download(...)

next(...)

set(...)

delete(...)

setBundleError(...)

list(...)

Packaging `dist.zip` update bundles