Types - Export
API reference for ./model/export on @huukhanhnguyen/types.
See the Guide for the package's role.
API reference
Signatures are generated from the live package .d.ts - not hand-written.
StepExportReport
type
User-facing STEP export report. Open shells are WRITTEN (listed under written); only mesh entities appear under meshSkip. Both the ExportMenu button and the chat export action MUST use this so the two surfaces cannot drift (open shells must never be labeled "skipped").
type StepExportReport
// = {
/** e.g. `"1 solid, 2 open shells"`. */
written: string;
/** Non-null only when meshes were skipped — never mentions open shells. */
meshSkip: string | null;
/** Non-null when a body carried geometry this kernel cannot express in
* STEP. Separate from `meshSkip`: that one is a deliberate format rule,
* this one is a limitation the reader deserves to hear about by name. */
unwritableSkip: string | null;
}StepResult
type
type StepResult
// = {
/** The ISO-10303-21 AP242 document. */
step: string;
/** Closed bodies written — one MANIFOLD_SOLID_BREP each. */
solids: number;
/** Open face clusters written as SHELL_BASED_SURFACE_MODEL / OPEN_SHELL. */
openShells: number;
/** Mesh entities skipped (see the module doc). */
meshes: number;
/** Bodies the kernel could not write (see {@link writeBodies}). Counted,
* never silent — a partial STEP file must say what is missing from it. */
unwritable: number;
}