@waline/client 2.0.0-alpha.4 → 2.0.2

package/dist/legacy.d.ts

@@ -296,8 +296,31 @@ interface WalineInitOptions extends Omit<WalineProps, 'path'> {
 }
 
 interface WalineInstance {
+    /**
+     * Waline 被挂载到的元素
+     *
+     * @description 当通过 `el: null` 初始化，值为 `null`
+     *
+     * Element where Waline is mounted
+     *
+     * @description when initialized with `el: null`, it will be `null`
+     */
     el: HTMLElement | null;
-    update: (newOptions: Partial<WalineProps>) => void;
+    /**
+     * 更新 Waline 实例
+     *
+     * @description 只要不设置`path` 选项，更新时它就会被重置为 `windows.location.pathname`
+     *
+     * Update Waline instance
+     *
+     * @description when not setting `path` option, it will be reset to `window.location.pathname`
+     */
+    update: (newOptions: Partial<Omit<WalineInitOptions, 'el'>>) => void;
+    /**
+     * 取消挂载并摧毁 Waline 实例
+     *
+     * Unmount and destroy Waline instance
+     */
     destroy: () => void;
 }