TS for GIR

TypeScript type definition generator for GObject introspection GIR files

ts-for-gir is a robust TypeScript type definitions generator that improves the development experience of GJS projects. It has been completely rewritten over time to provide a more complete and accurate TypeScript representation of the GObject introspection interfaces. With ts-for-gir, developers can now benefit from TypeScript's strong typing and improved code navigation, making it easier to build robust and powerful applications with GJS.

Branch "3.x" - Stable Version

You are on the 3.x branch. This are the stable features of ts-for-gir v3.x with support for GJS and node-gtk environments. Explore the 3.x branch to generate comprehensive TypeScript type definitions for GObject introspection modules. If you want to help us merge with gi.ts, check out v4.x on the main branch.

main branch: https://github.com/gjsify/ts-for-gir/tree/main
3.x branch: https://github.com/gjsify/ts-for-gir/tree/3.x

Getting Started

Install the latest LTS version of Node.js. We recommend using NVM for this purpose. After Node.js has been installed, ts-for-gir can be executed with the following command:

npx @ts-for-gir/cli --help

That's it, you can start generating your types 👩‍💻☕

NPM packages

If you are only interested in the types and do not want to generate them yourself, you can use our pre-generated NPM packages. For example, if you want to develop a Gtk4 application with GJS, it is enough to install the corresponding NPM packages:

npm install @girs/gjs @girs/gtk-4.0 --save

import '@girs/gjs'
import '@girs/gjs/dom'
import '@girs/gtk-4.0'

import Gtk from 'gi://Gtk?version=4.0';

const button = new Gtk.Button();

All pre-generated NPM packages can be found on gjsify/types.

You want your or any other missing GObject introspection based library types to be published on NPM for every release? Then feel free to create an issue for it, we will be happy to include it.

Maintainer wanted for node-gtk maintenance

Version 3.x has working node-gtk support. This is currently not planned for version 4.x. We ourselves want to focus on GJS support. However, if there is a need in the community to maintain node-gtk support, then we are looking for a maintainer for that. Feel free to get in touch 🤓

Further information

Examples - Take a look at many different examples to see how you can use TypeScript with different bundlers.
CLI - Learn about the CLI options and what to keep in mind when using them.
Development - Learn how you can contribute to this project.
gjsify/types - Pre-generated NPM packages that you can use directly without needing ts-for-gir for it. GNOME Shell Extension Types - Very experimental additional hand written type definitions for GNOME Shell Extensions.