API Reference / @gtkx/codegen / CodegenRunnerOptions

Type Alias: CodegenRunnerOptions

CodegenRunnerOptions = object

Defined in: codegen/dist/runner.d.ts:12

What to generate and where to write it.

Properties

gi

gi: StoreOptions

Defined in: codegen/dist/runner.d.ts:18

Where to write and link the @gtkx/gi store.

---

girPath

girPath: string[]

Defined in: codegen/dist/runner.d.ts:16

Directories to search for .gir files.

---

isByteArrayTyped?

optional isByteArrayTyped?: boolean

Defined in: codegen/dist/runner.d.ts:34

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

---

isFinishTrimmed?

optional isFinishTrimmed?: boolean

Defined in: codegen/dist/runner.d.ts:38

Drops the leading success boolean from promisified results of a throwing finish; defaults to false.

---

isForced?

optional isForced?: boolean

Defined in: codegen/dist/runner.d.ts:32

Regenerates both stores even when their fingerprints are fresh.

---

isInoutInPlace?

optional isInoutInPlace?: boolean

Defined in: codegen/dist/runner.d.ts:40

Mutates a handle-passing inout parameter in place instead of packing it into the result; defaults to false.

---

isTreeShaken?

optional isTreeShaken?: boolean

Defined in: codegen/dist/runner.d.ts:42

Folds registrations into each class so bundlers can drop unused ones; defaults to false.

---

isValueUnwrapped?

optional isValueUnwrapped?: boolean

Defined in: codegen/dist/runner.d.ts:36

Surfaces a GObject.Value a binding hands back as what it holds rather than as the value; defaults to false.

---

jsx?

optional jsx?: StoreOptions

Defined in: codegen/dist/runner.d.ts:20

Where to write and link the @gtkx/jsx store; omit to generate the gi store alone.

---

libraries

libraries: string[]

Defined in: codegen/dist/runner.d.ts:14

GIR library identifiers such as "Gtk-4.0"; a "*" selection must be expanded before it gets here.

---

reactSubexports?

optional reactSubexports?: string[]

Defined in: codegen/dist/runner.d.ts:22

Subexport names of the installed @gtkx/react, whose element config shapes the jsx store.

---

userComponents?

optional userComponents?: Record<string, ModuleExport>

Defined in: codegen/dist/runner.d.ts:24

Component wrappers the project layers over the built-ins, keyed by GLib type name.

---

userLazyElements?

optional userLazyElements?: string[]

Defined in: codegen/dist/runner.d.ts:26

GLib type names whose GObject their parent container creates, added to the framework's own.

---

userOmittedProps?

optional userOmittedProps?: OmittedProps

Defined in: codegen/dist/runner.d.ts:30

Props the project drops from the generated element props, keyed by GLib type name.

---

userProps?

optional userProps?: Record<string, ModuleExport>

Defined in: codegen/dist/runner.d.ts:28

Base props interfaces the project's elements extend, keyed by GLib type name.