Bitbybit Docs
    Preparing search index...

    Bitbybit Docs

    Bitbybit TypeScript API Reference

    This is the complete, generated reference for the Bitbybit 3D CAD platform - every class, method, input type and enum in the published @bitbybit-dev/* npm packages, produced by TypeDoc directly from the shipped type declarations, so it never drifts from the code you install.

    Roughly 1,400 algorithms are documented here, spanning four geometry kernels and three rendering engines. Use this site when you need the exact signature, parameter DTO or return type of a call. For task-oriented walkthroughs, worked examples and conceptual explanation, use learn.bitbybit.dev instead.

    I want to... Go to
    Browse every symbol in one place Full symbol index
    Do solid modelling - booleans, fillets, lofts, sweeps, STEP/IGES OCCT
    Do fast mesh booleans on manifold geometry Manifold
    Do script-driven constructive solid geometry JSCAD
    Work with NURBS curves and surfaces Verb input types
    Render results in BabylonJS Babylon
    Draw any geometry into a scene Draw
    Use vectors, matrices, lists and math helpers Vector, Math, Lists
    Load models, textures and files Asset
    See how the types relate Type hierarchy

    Everything lives under the root Bit namespace, split into three kinds of entry:

    • Operation classes - OCCT, JSCAD, Manifold, Vector, Draw, Babylon and their sub-classes. These carry the methods you call. A class such as OCCTShapes groups the constructors for a shape family; OCCTBooleans groups union, difference and intersection.
    • Input DTOs - under Bit.Inputs.*, one namespace per kernel (OCCT, JSCAD, Manifold, Verb, Base). Almost every method takes a single DTO argument rather than a positional parameter list, so the DTO page is where the defaults and units live. Kernels deliberately repeat names - there is a CircleDto in each - so read the namespace in the page title to be sure which one you are looking at.
    • Models and enums - under Bit.Models.*, the shapes returned to you, plus the enumerations used by the DTOs.
    npm install @bitbybit-dev/occt @bitbybit-dev/occt-worker
    

    The kernels are independent of any renderer and run in both Node.js and the browser. Pick the -worker variant in a browser app to keep the WASM kernel off the main thread. The scaffolding CLI sets up a working project in one command:

    npx @bitbybit-dev/create-app my-project --engine threejs