API reference
Every export of @pmndrs/bvh and its three, babylon and worker entry points, generated by TypeDoc from the source.
The API reference is generated by TypeDoc from the TSDoc comments of the four entry points, and published next to these docs:
Only what the entry points export is listed (src/index.ts, src/three/index.ts, src/babylon/index.ts, src/worker/index.ts). Each name
there is exported on purpose; anything else is internal.
Building it locally
pnpm docs:api # writes api-docs/, open api-docs/index.html
The configuration is typedoc.json at the repository root.
See also
- Introduction: what the package does, part by part.
- First build: the quick starts.
- Choosing a builder and SceneTrees: the two things most apps start with.