GTKX

API Reference / @gtkx/codegen / ApiReference

Interface: ApiReference ​

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

An index over the GIR data a project's bindings are generated from, queryable and renderable as Markdown.

Accessors ​

girFiles ​

Get Signature ​

get girFiles(): string[]

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

Paths of the .gir files the index was built from, including the ones pulled in as dependencies.

Returns ​

string[]

inputFiles ​

Get Signature ​

get inputFiles(): string[]

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

Returns ​

string[]

Methods ​

hasFreshInputs() ​

hasFreshInputs(): boolean

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

Returns ​

boolean

lookup() ​

lookup(query, kind?): ApiLookupResult

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

Resolves a name to a single symbol and renders its reference page. The name may be bare (Toast) or qualified (Adw.Toast), and is matched case-insensitively; a name several symbols answer to is reported as ambiguous rather than picked between.

Parameters ​

query ​

string

kind? ​

ApiSymbolKind

Restricts the match to one kind, which is how a class and its JSX element are told apart.

Returns ​

ApiLookupResult

namespaceOverview() ​

namespaceOverview(name): string | undefined

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

Renders one namespace's Markdown page: its import line and its symbol names grouped by kind. The namespace is matched case-insensitively, and an unindexed one yields undefined.

Parameters ​

name ​

string

Returns ​

string | undefined

namespaces() ​

namespaces(): ApiNamespaceSummary[]

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

A summary of every indexed namespace, ordered Adw, Gtk, then alphabetically.

Returns ​

ApiNamespaceSummary[]

overview() ​

overview(): string

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

Renders the reference's Markdown landing page: every namespace, its import path, and its totals.

Returns ​

string

search(options): ApiSymbol[]

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

Symbols whose name matches the query, best first: an exact name beats a prefix, which beats a substring, and shorter names win ties. An empty query matches nothing.

Parameters ​

options ​

ApiSearchOptions

Returns ​

ApiSymbol[]

symbolNames() ​

symbolNames(namespaceName): string[]

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

Sorted names of everything a namespace contributes, JSX elements included. The namespace is matched case-insensitively, and an unindexed one yields an empty array.

Parameters ​

namespaceName ​

string

Returns ​

string[]

symbols() ​

symbols(query?): ApiSymbol[]

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

Every indexed symbol the query keeps, ordered by namespace (Adw, then Gtk, then alphabetically) and name.

Parameters ​

query? ​

ApiSymbolQuery = {}

Returns ​

ApiSymbol[]