GTKX

API Reference / @gtkx/codegen / ApiSearchOptions

Type Alias: ApiSearchOptions ​

ApiSearchOptions = object

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

A fuzzy search over indexed symbol names.

Properties ​

kinds? ​

optional kinds?: ApiSymbolKind[]

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

Symbol kinds to keep; every kind when omitted.

limit? ​

optional limit?: number

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

Maximum number of results, 20 by default.

namespace? ​

optional namespace?: string

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

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

query ​

query: string

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

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