Class RemoteControllerSW

运行在 ServiceWorker 线程中的远程控制插件

Hierarchy

RemoteControllerBase
- RemoteControllerSW

Implements

ServiceWorkerPlugin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RemoteControllerSW(options: Options): RemoteControllerSW

Inherited from RemoteControllerBase.constructor
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-base.ts:22
Parameters
- options: Options
Returns RemoteControllerSW

Properties

Protected configBackup

configBackup: string

Private context

context: UseContext

Protected fetchConfigThrottle

fetchConfigThrottle: () => Promise<RemoteConfig>

Type declaration

- (): Promise<RemoteConfig>
- Returns Promise<RemoteConfig>

Readonly name

name: "@glacierjs/plugin-remote-controller" = PLUGIN_NAME

Protected options

options: Options = ...

Methods

Protected getConfig

getConfig(): Promise<{ config: RemoteConfig; configUpdated: boolean }>

Inherited from RemoteControllerBase.getConfig
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-base.ts:31
获取远程配置，并且判断配置是否进行了更新，返回给外部进行对应处理。

Returns Promise<{ config: RemoteConfig; configUpdated: boolean }>
Promise<{ config: RemoteConfig, configUpdated: boolean }

onFetch

onFetch(): Promise<void>

Implementation of ServiceWorkerPlugin.onFetch
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-sw.ts:36
在资源请求时，检查远程控制配置，并针对配置进行以下处理：
1. 开关关闭时，进行 ServiceWorker 卸载
2. 路由更新时，调用资源缓存插件（AssetsCache）更新路由。
Returns Promise<void>

onInstall

onInstall(): Promise<void>

Implementation of ServiceWorkerPlugin.onInstall
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-sw.ts:19
在 ServiceWorker 安装时检查远程控制开关，如果关闭了，则阻断安装流程，避免后续流程的副作用。

Returns Promise<void>

onUse

onUse(context: UseContext): void

Implementation of ServiceWorkerPlugin.onUse
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-sw.ts:12
Parameters
- context: UseContext
Returns void

Generated using TypeDoc