GTKX

API Reference / @gtkx/codegen / CodegenRunnerOptions

Type Alias: CodegenRunnerOptions ​

CodegenRunnerOptions = object

Defined in: packages/codegen/src/runner.ts:31

What to generate and where to write it.

Properties ​

gi ​

gi: StoreOptions

Defined in: packages/codegen/src/runner.ts:37

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

girPath ​

girPath: string[]

Defined in: packages/codegen/src/runner.ts:35

Directories to search for .gir files.

isForced? ​

optional isForced?: boolean

Defined in: packages/codegen/src/runner.ts:49

Regenerates both stores even when their fingerprints are fresh.

jsx? ​

optional jsx?: StoreOptions

Defined in: packages/codegen/src/runner.ts:39

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

libraries ​

libraries: string[]

Defined in: packages/codegen/src/runner.ts:33

GIR library identifiers such as "Gtk-4.0".

userComponents? ​

optional userComponents?: Record<string, ModuleExport>

Defined in: packages/codegen/src/runner.ts:41

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

userLazyElements? ​

optional userLazyElements?: string[]

Defined in: packages/codegen/src/runner.ts:43

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

userOmittedProps? ​

optional userOmittedProps?: OmittedProps

Defined in: packages/codegen/src/runner.ts:47

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

userProps? ​

optional userProps?: Record<string, ElementPropsExport>

Defined in: packages/codegen/src/runner.ts:45

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