Skip to content
Shapemetry

Types - STL

API reference for ./io/stl on @huukhanhnguyen/types — the option and result records of @huukhanhnguyen/io's STL reader/writer.

See the Guide for the package's role.

API reference

Signatures are generated from the live package .d.ts - not hand-written.

StlFacet

interface

One parsed STL facet: the stored normal plus its three corners.

Facet and not Triangle: the format's own word (facet normal … endfacet) names exactly what distinguishes this record from a bare triangle — it carries the normal STL stores per face. StlTriangle was tried on 2026-08-12 and Law 3 rejected it, model having declared that name for the three corners alone; that rival declaration is gone since the STL parser became scene's alone, and this is now the only parsed-STL shape there is.

interface StlFacet

StlOptions

type

type StlOptions
// = {
    /** Solid name: the 80-byte binary header, or the ASCII `solid`/`endsolid`
     *  token. Default "shapemetry". */
    name?: string;
    /** Expand BlockEntity via definitions (formats without instancing). */
    definitions?: Map<string, BlockDefinition> | ReadonlyMap<string, BlockDefinition>;
}
Last updated: 📖 1 min readEdit on GitHub