IfcOpenShell JS/TS

IfcOpenShell JS/TS provides JavaScript and TypeScript bindings to the IfcOpenShell C++ core through WebAssembly. The ifcopenshell package works in Node.js and browsers, with modules for reading and editing IFC files, processing geometry, and exporting geometry.

The guides below introduce the operations available in the current bindings. Examples use JavaScript ES modules and can also be used in TypeScript. Only File and geometry Iterator implement Disposable: release them with dispose() or TypeScript using to invoke their native destructors. Other wrappers use GC cleanup, and instance queries return ordinary JS arrays.

Note

The current JS/TS bindings are a work in progress. The API is subject to change. The current version of the JS/TS documentation has been generated with the assistance of generative AI.

See also

IfcOpenShell TypeScript API documents the JavaScript and TypeScript API in detail. The equivalent C++ and Python guides are in IfcOpenShell C++ and IfcOpenShell-Python. Geometry concepts and settings are shared with Geometry iterator and Geometry settings.