export.excel.api

Excel导出API层，提供服务端导出功能的客户端实现。

安装

npm install export.excel.api

功能

• 提供服务端导出API的客户端实现
• 支持自定义baseUrl和接口URL
• 封装了导出的完整流程（begin/append-data/complete/cancel）
• 提供类型安全的API调用

使用

import { ExportExcelApi } from 'export.excel.api';
import { ExportApiConfigOptions } from 'export.excel.api';

// 创建API实例并配置自定义URL
const apiConfig: ExportApiConfigOptions = {
  baseUrl: 'https://your-api-server.com',
  urls: {
    beginUrl: '/api/export/begin',
    appendDataUrl: '/api/export/append-data',
    completeUrl: '/api/export/complete',
    cancelUrl: '/api/export/cancel'
  }
};

const exportApi = new ExportExcelApi(apiConfig);

// 开始导出流程
const token = await exportApi.Begin(/* 参数 */);

// 追加数据
await exportApi.AppendData(token, /* 数据 */);

// 完成导出
await exportApi.Complete(token);

// 取消导出（可选）
// await exportApi.Cancel(token);

API

ExportExcelApi

服务端导出API客户端类。

构造函数(config?: ExportApiConfigOptions)

创建API实例。

参数：

• config：API配置选项，可选
  • baseUrl：API服务器基础URL
  • urls：各个接口的URL配置

Begin(params): Promise

开始导出流程。

返回：

• Promise<string>：导出令牌

AppendData(token: string, data: any): Promise

追加导出数据。

参数：

• token：导出令牌
• data：要追加的数据

Complete(token: string): Promise

完成导出流程。

参数：

• token：导出令牌

Cancel(token: string): Promise

取消导出流程。

参数：

• token：导出令牌

依赖

• export.excel.core：核心功能依赖
• axios：HTTP请求库

许可证

ISC