Skip to main content

Reference

API Reference

reload()

export const reload = (): Promise<void>

Reload the webview


syncOne(...)

export const syncOne = async (options: SyncOneOptions): Promise<SyncResult>

Sync One

ParamType
optionsSyncOneOptions

Returns: Promise<SyncResult>


syncAll(...)

export const syncAll = (callback: SyncCallback): void

Sync All

ParamType
callbackSyncCallback)

syncSome(...)

export const syncSome(options: SyncSomeOptions, callback: SyncCallback): void

Sync Some

ParamType
optionsSyncSomeOptions
callbackSyncCallback)

Interfaces

SyncResult

PropType
liveUpdateLiveUpdate
snapshotSnapshot | null
source'download' | 'cache'
activeApplicationPathChangedboolean

LiveUpdateConfig

PropType
appIdstring
channelstring
autoUpdateMethodAutoUpdateMethod
maxVersionsnumber
keystring

LiveUpdateError

PropType
appIdstring | undefined
failStep'CHECK' | 'DOWNLOAD' | 'UNPACK' | 'VERIFY' | 'UPDATE' | 'CANCEL'
messagestring

Snapshot

PropType
idstring
buildIdstring

SyncCallback

PropType
onError(error: LiveUpdateError) => void
onAppComplete(result: SyncResult) => void
onSyncComplete() => void

SyncOneOptions

PropType
appIdstring

SyncSomeOptions

PropType
appIdsstring[]

Type Aliases

LiveUpdate

Pick<LiveUpdateConfig, 'appId' | 'channel'>

AutoUpdateMethod

'none' | 'background'