API Reference / @gtkx/codegen / ApiSearchOptions

Type Alias: ApiSearchOptions

ApiSearchOptions = object

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

A fuzzy search over indexed symbol names.

Properties

kinds?

optional kinds?: ApiSymbolKind[]

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

Symbol kinds to keep; every kind when omitted.

---

limit?

optional limit?: number

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

Maximum number of results, 20 by default.

---

namespace?

optional namespace?: string

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

GIR namespace to keep, matched case-insensitively; every namespace when omitted.

---

query

query: string

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

Text matched case-insensitively against each symbol's name and its qualified Namespace.Name form.