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

The reference covers every published Beignet library, including the core subpaths, client integrations, runtime adapters, providers, webhook integrations, and CLI configuration API. For create-beignet commands, see the CLI guide.

Search the docs for an exact symbol such as createBullMQJobsProvider or createNextServerLoader. Results labeled API reference open the symbol's signature and options; guide results show how to use it in an application.