Skip to content

API Reference / @gtkx/codegen / loadApiReference

Function: loadApiReference() ​

loadApiReference(options): ApiReference

Defined in: packages/codegen/src/docs/api-reference.ts:198

Loads the GIR data for the given libraries and indexes every symbol and JSX element in it. The result is a read-only view: it generates no store and needs none, so a tool can explore the bindings a project would get without running codegen.

Parameters ​

options ​

ApiReferenceOptions

Which libraries to index, where to find them, and the project's element config.

Returns ​

ApiReference

The indexed reference.