IFClite TypeScript API
    Preparing search index...

    Interface IPlatformBridge

    Platform bridge interface - abstracts WASM vs native processing

    interface IPlatformBridge {
        getApi(): unknown;
        init(): Promise<void>;
        isInitialized(): boolean;
        planMapConversionNormalization?(content: Uint8Array): string;
        processGeometry(
            content: string | Uint8Array<ArrayBufferLike>,
        ): Promise<GeometryProcessingResult>;
        processGeometryPath?(path: string): Promise<GeometryProcessingResult>;
        processGeometryStreaming(
            content: string | Uint8Array<ArrayBufferLike>,
            options: StreamingOptions,
        ): Promise<PlatformGeometryStats>;
        processGeometryStreamingCache?(
            cacheKey: string,
            options: StreamingOptions,
        ): Promise<PlatformGeometryStats>;
        processGeometryStreamingPath?(
            path: string,
            options: StreamingOptions,
            cacheKey?: string,
        ): Promise<PlatformGeometryStats>;
    }
    Index
    • Get the underlying API object (for advanced usage) Returns the WASM IfcAPI in web, or null in Tauri

      Returns unknown

    • Initialize the bridge (WASM loading for web, no-op for native)

      Returns Promise<void>

    • Check if the bridge is initialized

      Returns boolean

    • Optional canonical coordinate compatibility export capability.

      Parameters

      • content: Uint8Array

      Returns string

    • Process IFC content and return all geometry at once

      Parameters

      • content: string | Uint8Array<ArrayBufferLike>

        IFC file content as string or raw bytes

      Returns Promise<GeometryProcessingResult>

    • Process IFC geometry directly from a filesystem path when supported. Native desktop bridges can avoid copying huge files through JS/IPC.

      Parameters

      • path: string

      Returns Promise<GeometryProcessingResult>

    • Process IFC content with streaming output

      Parameters

      • content: string | Uint8Array<ArrayBufferLike>

        IFC file content as string or raw bytes

      • options: StreamingOptions

        Streaming options with callbacks

      Returns Promise<PlatformGeometryStats>