TypeScript API Documentation for GJS

TS for GIR

This is the TypeScript API reference for GJS — the GNOME JavaScript runtime. Browse the modules below to find detailed type information for GLib, GTK, GStreamer, and many other GNOME libraries.

All type definitions are auto-generated from GObject Introspection data using ts-for-gir and can be installed as NPM packages for use in your projects. You can also use ts-for-gir to generate the type definitions and this documentation yourself for any GIR module available on your system.

Install

Each documented module is available as a pre-generated NPM package under the @girs scope. For example, to develop a GTK 4 application with GJS:

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 packages can be found on gjsify/types.

Showcase

GNOME Applications

Audio Player - Play audio files
Counters - Keep track of anything
Ignition - Manage startup apps and scripts
Learn 6502 - Learn program vintage Game Consoles
Sound Recorder - A simple, modern sound recorder
Sticky Notes - Pin notes to your desktop
Weather - Show weather conditions and forecast
K'uychi - Generate color palettes

GNOME Shell Extensions

gTile - Tiling window management for GNOME Shell
Copyous - Clipboard manager for GNOME Shell
Rounded Window Corners - Add rounded corners to windows

Example Projects

Looking for a starting point? These example projects demonstrate how to use the TypeScript definitions with various bundlers:

GTK 4 Template with Vite - Modern UI with Vite bundling
GNOME TypeScript Template - A template using GTK, libadwaita, TypeScript, Flatpak, and Meson

More examples with screenshots and descriptions can be found in the ts-for-gir examples directory.

Resources

GJS Guide - Comprehensive guide for GJS development
GTK Documentation - Official GTK documentation
JavaScript API References - GJS JavaScript API reference
ts-for-gir - The generator behind these type definitions
GNOME Shell Extension Types - Type definitions for GNOME Shell Extensions

Modules

The following modules are documented on this site, grouped by category. Click on any module to browse its classes, interfaces, enums, functions, and constants.

GJS Core

Gjs: GJS is a JavaScript runtime for the GNOME ecosystem. This package provides core type definitions for GJS built-in modules.

GLib

Gio-2.0: GIO provides a modern and easy-to-use VFS API, including file system abstraction, networking, D-Bus support, and application infrastructure.
GLib-2.0: GLib provides the core application building blocks for libraries and applications written in C. It provides the core object system used in GNOME, the main loop implementation, and a large set of utility functions for strings and common data structures.
GModule-2.0: Portable method for dynamically loading plug-ins.
GObject-2.0: The base type system and object class library, providing signal/callback handling, properties, and reference counting.

GTK 4

Gdk-4.0: The GTK windowing system abstraction.
Gsk-4.0: The GTK rendering API.
Gtk-4.0: The GTK toolkit — primary library for constructing user interfaces in GNOME applications.

GTK 3

Gdk-3.0: The GTK windowing system abstraction.
Gtk-3.0: The GTK toolkit — primary library for constructing user interfaces in GNOME applications.

Pango

Pango-1.0: Pango is a library for laying out and rendering text, with an emphasis on internationalization.
PangoCairo-1.0: Cairo rendering support for Pango.

Graphics

cairo-1.0: A 2D graphics library with support for multiple output devices.
GdkPixbuf-2.0: Image loading library.
Graphene-1.0: A thin layer of mathematical types for 3D libraries.

Text Rendering

freetype2-2.0: A freely available software library to render fonts.
HarfBuzz-0.0: A text shaping engine — converts Unicode text to glyph indices and positions.

Multimedia

Gst-1.0: Powerful framework for creating multimedia applications.
GstApp-1.0: GStreamer app library.
GstAudio-1.0: GStreamer Audio Library.
GstBase-1.0: GStreamer base plugin libraries.
GstPbutils-1.0: General application and plugin utility library.
GstTag-1.0: GStreamer tag support library.
GstVideo-1.0: Support library for video operations.

Web

JavaScriptCore-6.0: JavaScript engine used by WebKitGTK.
WebKit-6.0: A full-featured port of the WebKit rendering engine for GTK.

GNOME Libraries

Adw-1: Building blocks for modern adaptive GNOME applications.
GtkSource-5: A GNOME library that extends GtkTextView with syntax highlighting, undo/redo, search and replace, a completion system, and other source code editing features.
Json-1.0: A library providing serialization and deserialization support for the JSON format.
NM-1.0: Network management daemon and client library.
Notify-0.7: A library for sending desktop notifications.
Polkit-1.0: Application-level toolkit for defining and handling authorization policies.
Secret-1: A library for accessing the Secret Service API of the freedesktop.org project.
Shumate-1.0: A library providing a widget to display maps in applications.
Soup-3.0: HTTP client/server library for GNOME.

Other

AppStream-1.0: GJS TypeScript type definitions for AppStream-1.0, generated from library version 1.1.1
Atk-1.0: GJS TypeScript type definitions for Atk-1.0, generated from library version 2.58.3
Atspi-2.0: GJS TypeScript type definitions for Atspi-2.0, generated from library version 2.0.0
DBus-1.0: GJS TypeScript type definitions for DBus-1.0, generated from library version 1.0.0
Dex-1: GJS TypeScript type definitions for Dex-1, generated from library version 1.0.0
Flatpak-1.0: GJS TypeScript type definitions for Flatpak-1.0, generated from library version 1.16.1
Gck-2: GJS TypeScript type definitions for Gck-2, generated from library version 4.4.0
Gcr-4: GJS TypeScript type definitions for Gcr-4, generated from library version 4.4.0
GdkWayland-4.0: GJS TypeScript type definitions for GdkWayland-4.0, generated from library version 4.0.0
GdkX11-4.0: GJS TypeScript type definitions for GdkX11-4.0, generated from library version 4.0.0
GES-1.0: GJS TypeScript type definitions for GES-1.0, generated from library version 1.24.7
Goa-1.0: GJS TypeScript type definitions for Goa-1.0, generated from library version 3.56.0
Grl-0.3: GJS TypeScript type definitions for Grl-0.3, generated from library version 0.3.0
GrlNet-0.3: GJS TypeScript type definitions for GrlNet-0.3, generated from library version 0.3.0
GSSDP-1.6: GJS TypeScript type definitions for GSSDP-1.6, generated from library version 1.6.0
GstGL-1.0: GJS TypeScript type definitions for GstGL-1.0, generated from library version 1.0.0
GstPlayer-1.0: GJS TypeScript type definitions for GstPlayer-1.0, generated from library version 1.0.0
GstSdp-1.0: GJS TypeScript type definitions for GstSdp-1.0, generated from library version 1.0.0
GstWebRTC-1.0: GJS TypeScript type definitions for GstWebRTC-1.0, generated from library version 1.0.0
GUdev-1.0: GJS TypeScript type definitions for GUdev-1.0, generated from library version 1.0.0
GUPnP-1.6: GJS TypeScript type definitions for GUPnP-1.6, generated from library version 1.6.0
GWeather-4.0: GJS TypeScript type definitions for GWeather-4.0, generated from library version 4.0.0
Jsonrpc-1.0: GJS TypeScript type definitions for Jsonrpc-1.0, generated from library version 3.44.2
Libosinfo-1.0: GJS TypeScript type definitions for Libosinfo-1.0, generated from library version 1.12.0
libxml2-2.0: GJS TypeScript type definitions for libxml2-2.0, generated from library version 2.0.0
Panel-1: GJS TypeScript type definitions for Panel-1, generated from library version 1.10.2
Peas-2: GJS TypeScript type definitions for Peas-2, generated from library version 2.0.0
PolkitAgent-1.0: GJS TypeScript type definitions for PolkitAgent-1.0, generated from library version 1.0.0
Poppler-0.18: GJS TypeScript type definitions for Poppler-0.18, generated from library version 25.9.1
Rest-1.0: GJS TypeScript type definitions for Rest-1.0, generated from library version 1.0.0
Rsvg-2.0: GJS TypeScript type definitions for Rsvg-2.0, generated from library version 2.61.3
Spelling-1: GJS TypeScript type definitions for Spelling-1, generated from library version 1.0.0
Template-1.0: GJS TypeScript type definitions for Template-1.0, generated from library version 3.38.0
Tsparql-3.0: GJS TypeScript type definitions for Tsparql-3.0, generated from library version 3.10.1
Vte-3.91: GJS TypeScript type definitions for Vte-3.91, generated from library version 0.82.1
WebKitWebProcessExtension-6.0: GJS TypeScript type definitions for WebKitWebProcessExtension-6.0, generated from library version 6.0.0
Wnck-3.0: GJS TypeScript type definitions for Wnck-3.0, generated from library version 43.0.0
Xdp-1.0: GJS TypeScript type definitions for Xdp-1.0, generated from library version 1.0.0
XdpGtk4-1.0: GJS TypeScript type definitions for XdpGtk4-1.0, generated from library version 1.0.0
xlib-2.0: GJS TypeScript type definitions for xlib-2.0, generated from library version 2.0.0