API Reference / @gtkx/codegen / ApiReference
Interface: ApiReference
Defined in: codegen/dist/docs/api-reference.d.ts:95
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: codegen/dist/docs/api-reference.d.ts:120
Paths of the .gir files the index was built from, including the ones pulled in as dependencies.
Returns
string[]
Methods
lookup()
lookup(
query,kind?):ApiLookupResult
Defined in: codegen/dist/docs/api-reference.d.ts:128
Resolves a name to a single symbol and renders its reference page. The name may be bare (Button) or qualified (Gtk.Button), and is matched case-insensitively; a name several symbols answer to is reported as ambiguous rather than picked between.
Parameters
query
string
kind?
Restricts the match to one kind, which is how a class and its JSX element are told apart.
Returns
namespaceOverview()
namespaceOverview(
name):string|undefined
Defined in: codegen/dist/docs/api-reference.d.ts:149
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: codegen/dist/docs/api-reference.d.ts:137
A summary of every indexed namespace, ordered Gtk, Adw, then alphabetically.
Returns
overview()
overview():
string
Defined in: codegen/dist/docs/api-reference.d.ts:144
Renders the reference's Markdown landing page: every namespace, its import path, and its totals.
Returns
string
search()
search(
options):ApiSymbol[]
Defined in: codegen/dist/docs/api-reference.d.ts:135
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
Returns
symbolNames()
symbolNames(
namespaceName):string[]
Defined in: codegen/dist/docs/api-reference.d.ts:142
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: codegen/dist/docs/api-reference.d.ts:130
Every indexed symbol the query keeps, ordered by namespace (Gtk, then Adw, then alphabetically) and name.