IFClite TypeScript API
    Preparing search index...

    Interface StepExportResult

    Result of STEP export

    interface StepExportResult {
        content: Uint8Array;
        stats: {
            entityCount: number;
            fileSize: number;
            modifiedEntityCount: number;
            newEntityCount: number;
            warnings: string[];
        };
    }
    Index
    content stats

    content

    content: Uint8Array

    STEP file content as bytes (avoids V8 string length limit for large files)

    stats: {
        entityCount: number;
        fileSize: number;
        modifiedEntityCount: number;
        newEntityCount: number;
        warnings: string[];
    }

    Statistics about the export

    Type Declaration

    • entityCount: number

      Total entities exported

    • fileSize: number

      File size in bytes

    • modifiedEntityCount: number

      Entities modified by mutations

    • newEntityCount: number

      New entities created for mutations

    • warnings: string[]

      Non-fatal refusals: things the caller asked for that this export could not write. Empty when the export did everything it was asked to do.

      A requested georefMutations.mapConversion is one case: with no IfcGeometricRepresentationContext to reference as SourceCRS, the IfcMapConversion is skipped (writing it would produce a dangling reference) while the IfcProjectedCRS is still written — so the output is indistinguishable from "no map conversion was requested" unless the caller reads this (#2067).

      A WITHHELD RELATIONSHIP is the other: when a relationship names an entity this export is not writing, in a slot with no spelling for an omitted reference, the whole relationship line is dropped rather than shipped dangling — see relationshipWithheldWarning. This can happen on a plain full export with no options set at all, so it is reported rather than left to be discovered by a diff.

      Same string[] shape as MergeExportResult.stats.warnings.

    Settings
    Member Visibility

    On This Page
    Properties