Fabric.js Document Engine

搜索文档

查找页面或章节

EN

每种失败都有一个稳定的 code,可以直接用来判断。

每种失败都是带稳定 code 的 DocumentEngineError。文档引擎错误码在 1.x 期间永远不会变,所以请按 code 判断,不要按消息文字判断。

import { isDocumentEngineError } from "fabricjs-document-engine";
 
try {
  await engine.load(id);
} catch (error) {
  if (isDocumentEngineError(error) && error.code === "UNSAVED_CHANGES") {
    await engine.save();
    await engine.load(id);
  }
}

尺寸超过画布大小限制时,导出和图片检查还会报告问题代码 TOO_LARGE。除了 code,错误还可能带有 issues、unknownTypes、missingAssets、missingFonts、problems、migrationFrom、retryable 和 cause。

全部文档引擎错误码

错误码触发时机
INVALID_DOCUMENT文档结构不对,或导入的文本不是 JSON
UNSAFE_DOCUMENT不安全的图片地址、对象太多或嵌套太深
UNSUPPORTED_SCHEMA由这个包更新的大版本写入
UNKNOWN_OBJECT_TYPE自定义类没有注册
INVALID_CUSTOM_OBJECT注册的类没有静态 type,或不是 Fabric.js 类
MIGRATION_FAILED旧文档无法升级
LOAD_ABORTED加载的 signal 被取消,或更新的加载或 destroy 中止了它
LOAD_CONFLICT文档加载期间画布被编辑过,编辑会被保留
LOAD_FAILEDFabric.js 或存储加载失败
MISSING_ASSETS有图片无法加载,missingAssets 的每一项都有 failure.reason
MISSING_FONTS字体不可用,且开启了 requireFonts
ASSET_UPLOAD_FAILEDupload 处理函数失败
UNSAVED_CHANGES打开另一份文档会丢掉未保存的改动
STORAGE_MISSING没有存储却调用了 load、save 或自动保存
SAVE_FAILED重试后存储仍然拒绝
SAVE_CONFLICT另一个标签页或设备先保存了
SAVE_CANCELLED因为打开了另一份文档或引擎被销毁,保存被丢弃
DOCUMENT_NOT_FOUND内置适配器里没有这份文档
HISTORY_FAILED撤销或重做无法重建对象
RECOVERY_MISSING没有配置恢复
RECOVERY_NOT_FOUND没有恢复副本
RECOVERY_FAILED无法写入恢复副本
VERSIONS_UNSUPPORTED存储没有版本相关的方法
VERSION_NOT_FOUND没有这个版本
VERSION_FAILED自动版本失败
INVALID_EXPORT_OPTIONS导出配置无效
EXPORT_BLOCKED有图片或字体会让导出出错,见 error.problems
EXPORT_ABORTED导出被取消
EXPORT_FAILED渲染失败
SVG_IMPORT_FAILEDimportSvg 收到的文本不是有效的 SVG
LOAD_CONFLICT文档打开期间画布被修改了。传入 discardUnsavedChanges 才会替换这些修改
DOCUMENT_CHANGED导入、粘贴或替换图片在另一个文档打开之后才完成,所以被丢弃
PDF_UNAVAILABLE没有安装 jspdf 或 svg2pdf.js,或者没有浏览器
PDF_FAILED字体不是 TrueType,或 PDF 无法生成
DOCUMENT_CHANGED异步操作在另一个文档打开之后才完成,结果被丢弃
ENGINE_DESTROYED在 destroy() 之后仍使用了引擎

过大的导出会以 EXPORT_BLOCKED 失败,并带有代码为 TOO_LARGE 的问题;过大的图片会以原因 TOO_LARGE 失败,见 画布大小限制。SVG 导出中被画成图片的对象会带有 CLIP_PATH_RASTERIZED 警告。

需要界面处理的几个

大多数文档引擎错误码记下日志就可以了。下面这几个需要用户做决定,请给它们一个对话框:SAVE_CONFLICT(保存冲突)、MISSING_ASSETS(图片和字体)和 UNSAVED_CHANGES。完整的处理代码见上线清单。

文档引擎错误码 | Fabric.js Document Engine