API Reference / @gtkx/codegen / ApiLookupResult

Type Alias: ApiLookupResult

ApiLookupResult = { markdown: string; outcome: "page"; symbol: ApiSymbol; } | { candidates: ApiSymbol[]; outcome: "ambiguous"; } | { outcome: "notFound"; }

Defined in: codegen/dist/docs/api-reference.d.ts:46

What an ApiReference.lookup found: a rendered page, several candidates for the name, or nothing.

Union Members

Type Literal

{ markdown: string; outcome: "page"; symbol: ApiSymbol; }

markdown

markdown: string

The symbol's complete reference page, rendered as Markdown.

outcome

outcome: "page"

Discriminant selecting the variant.

symbol

symbol: ApiSymbol

Index entry for the symbol the query resolved to.

---

Type Literal

{ candidates: ApiSymbol[]; outcome: "ambiguous"; }

candidates

candidates: ApiSymbol[]

Every symbol the name answers to, to be narrowed by namespace or kind.

outcome

outcome: "ambiguous"

Discriminant selecting the variant.

---

Type Literal

{ outcome: "notFound"; }

outcome

outcome: "notFound"

Discriminant selecting the variant.