API reference

Beignet's API reference is generated from the public TypeScript exports and TSDoc comments in the package source. Use it when you need exact function signatures, option shapes, return types, class members, or provider exports.

The guide pages explain how the framework pieces fit together. The generated reference answers what a specific public API accepts and returns.

Open generated API reference