Function Lookup
A pointer to brepjs's auto-generated alphabetical index. The full table is generated from source (CI fails any change that leaves it stale) and lives at docs/function-lookup.md in the repository.
How to use it
Each entry maps a symbol to its sub-path:
box topology
cylinder topology
sphere topology
sketchCircle sketching
exportSTEP io
measureVolume measurement
edgeFinder queryTo import any symbol, you can either go through the main entry:
typescript
import { box, sphere, sketchCircle, exportSTEP } from 'brepjs';…or use the sub-path for smaller autocomplete:
typescript
import { box, sphere } from 'brepjs/topology';
import { sketchCircle } from 'brepjs/sketching';
import { exportSTEP } from 'brepjs/io';Read the full lookup
The complete index is one of:
- In the repository:
docs/function-lookup.mdon the main branch - Searchable API reference: andymai.github.io/brepjs: full TypeDoc with type signatures, examples, source links
Available sub-paths
| Sub-path | Contents |
|---|---|
brepjs/core | Result, errors, vectors, planes, branded types, disposal |
brepjs/topology | Primitives, batch booleans, modifiers, mesh cache, healing |
brepjs/operations | Extrude variants, sweep, patterns, assembly, history |
brepjs/2d | Drawings, 2D curves, 2D booleans |
brepjs/sketching | Sketcher, drawing-to-sketch, sketch-to-shape ops |
brepjs/query | Edge / face / corner finders |
brepjs/measurement | Volume, area, length, distance |
brepjs/io | STEP, IGES, STL, OBJ, glTF, DXF, 3MF, SVG |
brepjs/worker | Worker RPC client / server |
brepjs/shapeRef | Stable entity references (faces/edges/vertices) that survive parametric edits |
brepjs/quick | Auto-init re-export of everything (top-level await) |
When the lookup says one thing and TypeDoc says another
CI fails any change that leaves the lookup stale, and TypeDoc is rebuilt after each passing CI run on main, so the two should agree. TypeDoc is authoritative. If the two disagree, file an issue and the lookup will be regenerated.
Regenerating the lookup
If you're a contributor:
bash
npm run docs:generate-lookupThe pre-commit hook reminds you to run this when *Fns.ts files have changed.
Next steps
- TypeDoc API Reference: searchable type-level reference
- Cheat Sheet: task-oriented code snippets
- Glossary: concept-oriented terms