API Reference / @gtkx/codegen / ApiReferenceOptions

Type Alias: ApiReferenceOptions

ApiReferenceOptions = object

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

What to index and the element config the rendered pages reflect.

Properties

girPath

girPath: string[]

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

Directories to search for .gir files.

---

isByteArrayTyped?

optional isByteArrayTyped?: boolean

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

Describes GIR byte sequences as Uint8Array rather than number[]; defaults to false.

---

isFinishTrimmed?

optional isFinishTrimmed?: boolean

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

Describes promisified results of a throwing finish without their leading success boolean; off by default.

---

isInoutInPlace?

optional isInoutInPlace?: boolean

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

Describes a handle-passing inout parameter as mutated in place rather than returned; off by default.

---

isTreeShaken?

optional isTreeShaken?: boolean

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

Folds registrations into each class so bundlers can drop unused ones; off by default.

---

isValueUnwrapped?

optional isValueUnwrapped?: boolean

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

Describes what a GObject.Value a binding hands back holds, rather than the value itself; off by default.

---

libraries

libraries: string[]

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

GIR library identifiers to load, such as "Gtk-4.0"; their dependencies are pulled in too.

---

omittedProps?

optional omittedProps?: OmittedProps

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

GObject properties the project omits from generated props; without it pages show props that do not exist.

---

props?

optional props?: ElementProps

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

Base props interfaces per element, as read by readBuiltinElements; without it pages miss them.