@flyfish-group/file-viewer3 1.0.6 → 1.0.8

package/dist/src/package/common/type.d.ts

@@ -1,28 +1,39 @@
 import { App } from 'vue';
 /**
- * 声明vue包装
+ * 渲染器返回的 Vue 包装实例。
+ *
+ * Vue3 渲染器直接返回 `App`，少量兼容渲染器会返回只暴露 `$el`
+ * 与 `unmount()` 的轻量包装对象。
  */
 export interface AppWrapper {
     $el: Node;
     unmount(): void;
 }
 /**
- * 声明别名
+ * 任意渲染器挂载完成后返回的可卸载实例。
  */
 export type Rendered = App | AppWrapper;
 /**
- * 文件引用，支持三种
+ * 组件可接受的本地二进制来源。
+ *
+ * 对外接入时最推荐传入带正确文件名的 `File`。如果业务侧拿到的是
+ * `Blob` 或 `ArrayBuffer`，请先包装成 `new File([...], 'demo.pdf')`，
+ * 这样渲染器才能通过扩展名选择正确的预览链路。
  */
 export type FileRef = File | Blob | ArrayBuffer;
 /**
- * 文件处理逻辑，用于声明文件处理器
+ * 文件处理逻辑，用于声明具体格式的异步渲染器。
+ *
+ * 渲染器只在命中文件扩展名时被按需加载，避免 PDF、OFD、CAD、Office
+ * 等重型依赖进入无关格式的首屏路径。
+ *
  * @param buffer 二进制缓存
  * @param target 目标dom
  * @param type 目标扩展名。部分渲染器会用它选择语言、容错策略或格式提示。
  */
 export type FileHandler = (buffer: ArrayBuffer, target: HTMLDivElement, type?: string) => Promise<Rendered>;
 /**
- * 文件处理器组合
+ * 文件处理器组合。
  */
 export interface FileHandlerComposite {
     accepts: Array<string>;

package/dist/src/package/components/FileViewer/FileViewer.vue.d.ts

@@ -1,6 +1,18 @@
 import { FileRef } from '../../common/type';
 type __VLS_Props = {
+    /**
+     * 本地二进制输入。优先级高于 `url`。
+     *
+     * 推荐传入带正确扩展名的 `File`；如果业务侧只有 Blob 或 ArrayBuffer，
+     * 请先包装成 `new File([...], 'demo.pdf')`，保证格式识别稳定。
+     */
     file?: FileRef;
+    /**
+     * 远端文件地址。组件会在浏览器内下载该地址，再根据路径里的扩展名选择渲染器。
+     *
+     * 目标资源必须允许浏览器访问；鉴权或无扩展名下载接口建议由宿主侧先取回，
+     * 再通过 `file` 参数传入。
+     */
     url?: string;
 };
 declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;

package/dist/src/package/index.d.ts

@@ -1,10 +1,13 @@
 import { default as FileViewer } from './components/FileViewer';
 import { App } from 'vue';
 declare interface FileViewerInstaller {
+    /**
+     * 全局注册 `<file-viewer>` 组件。
+     */
     install(app: App): void;
 }
 /**
- * 安装器
+ * Vue3 插件安装器。
  */
 declare class Installer implements FileViewerInstaller {
     private installed;