Skip to main content

Reference

Index

reload()

export const reload = (): Promise<void>

Reload the webview

Returns: Promise<void>


syncOne(...)

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

Sync One

ParamType
optionsSyncOneOptions

Returns: Promise<LiveUpdateResult>


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

SyncOneOptions

PropType
appIdstring

LiveUpdateConfig

PropType
appIdstring
channelstring
autoUpdateMethodAutoUpdateMethod
maxVersionsnumber

LiveUpdateError

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

SyncSomeOptions

PropType
appIds[]string

SyncCallback

PropType
onError(error: LiveUpdateError) => void
onAppComplete(liveUpdate: LiveUpdate) => void
onSyncComplete() => void

Type Aliases

LiveUpdateResult

LiveUpdate | LiveUpdateError

LiveUpdate

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

AutoUpdateMethod

'none' | 'background'

SyncResult

LiveUpdateResult | { complete: true }