Skip to content

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            query

To 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:

Available sub-paths ​

Sub-pathContents
brepjs/coreResult, errors, vectors, planes, branded types, disposal
brepjs/topologyPrimitives, batch booleans, modifiers, mesh cache, healing
brepjs/operationsExtrude variants, sweep, patterns, assembly, history
brepjs/2dDrawings, 2D curves, 2D booleans
brepjs/sketchingSketcher, drawing-to-sketch, sketch-to-shape ops
brepjs/queryEdge / face / corner finders
brepjs/measurementVolume, area, length, distance
brepjs/ioSTEP, IGES, STL, OBJ, glTF, DXF, 3MF, SVG
brepjs/workerWorker RPC client / server
brepjs/shapeRefStable entity references (faces/edges/vertices) that survive parametric edits
brepjs/quickAuto-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-lookup

The pre-commit hook reminds you to run this when *Fns.ts files have changed.

Next steps ​

Released under the Apache 2.0 License.