API Reference / @gtkx/codegen / readGeneratedLibraries

Variable: readGeneratedLibraries

const readGeneratedLibraries: (giStoreDir) => GeneratedLibraries | null

Defined in: codegen/dist/store/gi/generated-libraries.d.ts:24

Reads which GIR libraries a generated @gtkx/gi store binds and which release of each its GIR declared, out of the inventory codegen writes into the store. Answers "what does this project bind, and how new does the installed library have to be" without parsing a .gir file or querying pkg-config.

Parameters

giStoreDir

string

The gi store directory, as given by resolveStore(projectRoot).gi.storeDir.

Returns

GeneratedLibraries | null

What the store recorded, or null when it holds no inventory codegen wrote, which covers an absent, unreadable, unparseable and structurally foreign store file alike.