@capacitor/live-updates v0.3.1

@capacitor/live-updates

Official Live Updates plugin for Capacitor

Install

npm install @capacitor/live-updates
npx cap sync

API

• sync()
• setConfig(...)
• getConfig()
• resetConfig()
• reload()
• Interfaces
• Type Aliases

sync(...)

sync(progress: ((percentage: number) => void) | undefined = undefined) => Promise<SyncResult>

Sync the app with Live Updates. Optionally takes a progress callback.

Returns: Promise<SyncResult>

setConfig(...)

setConfig(config: LiveUpdateConfig) => Promise<void>

getConfig()

getConfig() => Promise<LiveUpdateConfig>

Returns: Promise<LiveUpdateConfig>

resetConfig()

resetConfig() => Promise<void>

reload()

reload() => Promise<void>

Interfaces

SyncResult

LiveUpdate

Snapshot

LiveUpdateError

LiveUpdateConfig

Type Aliases

LiveUpdateResult

SyncResult | LiveUpdateError

AutoUpdateMethod

'none' | 'background'

LiveUpdateConfig

Partial<LiveUpdate> & { autoUpdateMethod?: 'none' | 'background'; strategy?: 'zip' | 'differential'; enabled?: boolean; maxVersions?: number; }

Partial

Make all properties in T optional

{ P in keyof T?: TP; }