Skip to content

SDK 包结构

ComPDF Conversion Node.js 发版包包含以下文件:

text
lib/
  index.js
  index.d.ts
  ComPDF_conversion_node.node
  libcpdfconversionsdk.so
  libDocumentAI.so.4.0.0
  libonnxruntime.so.1.18.0
  libopencv_world.so.410
resource/
  models/
    documentai.model
samples/
  demo/
    demo.js
  license.xml
  input_files/
    word.pdf
    excel.pdf
    powerpoint.pdf
  output_files/        # 示例输出目录
doc/
  api_reference_node.html
  developer_guide_node.md
  html/
legal.txt
release_notes.txt

主要目录说明:

  • lib/index.js:发版示例直接加载的 SDK 入口文件,会从同一目录加载 native addon。
  • lib/index.d.ts:TypeScript 类型声明,描述转换选项、回调和导出函数。
  • lib/ComPDF_conversion_node.node:编译后的 Node-API addon。
  • lib/*.so:Linux 原生运行时库。
  • resource/models/:示例使用的 DocumentAI 模型。
  • samples/demo/demo.js:发版示例入口。
  • samples/input_files/:内置示例 PDF 文件。
  • samples/output_files/:发版包提供的示例输出目录。
  • samples/license.xml:示例默认使用的许可证文件。
  • doc/:API 参考和开发者文档。
  • legal.txt:法律和版权信息。
  • release_notes.txt:发布说明。

加载 Node.js SDK

发版包已在 lib/ 目录下包含 SDK 运行时,运行内置示例不需要安装步骤。

从发版包运行示例时,请在包根目录下执行:

shell
cd /path/to/ComPDF_conversion_node
node samples/demo/demo.js

示例通过以下方式加载 SDK:

js
const sdk = require("../../lib/index.js");