API Reference

@univerjs-pro/bases-exchange-client

Base import and export client integration for Web SDK.

TypeScript
import { UniverBasesExchangeClientPlugin } from '@univerjs-pro/bases-exchange-client'import {  ExchangeBaseExportMode,  ExchangeBaseFormulaPolicy,  ExchangeBaseImportMode,} from '@univerjs-pro/exchange-client'import '@univerjs-pro/bases-exchange-client/lib/index.css'univer.registerPlugin(UniverBasesExchangeClientPlugin, {  importSourceMode: ExchangeBaseImportMode.AUTO,  importFormulaPolicy: ExchangeBaseFormulaPolicy.CONVERT_THEN_VALUES,  exportStructureMode: ExchangeBaseExportMode.TABLES,  exportFormulaPolicy: ExchangeBaseFormulaPolicy.FAIL,})

IUniverBasesExchangeClientConfig

TypeScript
export interface IUniverBasesExchangeClientConfig {  menu?: MenuConfig  importSourceMode?: ExchangeBaseImportMode  importFormulaPolicy?: ExchangeBaseFormulaPolicy  exportStructureMode?: ExchangeBaseExportMode  exportFormulaPolicy?: ExchangeBaseFormulaPolicy}

Entry Points

  • Facade: @univerjs-pro/bases-exchange-client/facade
  • Locale: @univerjs-pro/bases-exchange-client/locale/*
  • Style: @univerjs-pro/bases-exchange-client/lib/index.css

Facade API

TypeScript
import '@univerjs-pro/bases-exchange-client/facade'importBaseToUnitIdAsync(file: File | string): Promise<string | undefined>importBaseToSnapshotAsync(file: File | string): Promise<IBaseSnapshot | undefined>exportBaseByUnitIdAsync(unitId: string, format?: ExchangeFormat, tableId?: string): Promise<File | undefined>exportBaseBySnapshotAsync(snapshot: IBaseSnapshot, format?: ExchangeFormat, tableId?: string): Promise<File | undefined>transformSnapshotJsonToBaseDataAsync(json: ISnapshotBlockJsonResponse): Promise<IBaseSnapshot>transformBaseDataToSnapshotJsonAsync(baseData: IBaseSnapshot): Promise<ISnapshotBlockJson>

How is this guide?

© 2026 DreamNum Co., Ltd.