Gr3q / types-gjs

Typescript definitions for GJS - Gnome JavaScript
MIT License
7 stars 2 forks source link

types-gjs

This repo was a dependency of GitHub - Gr3q/types-cjs: Typescript declarations for CJS - Cinnamon JavaScript and now deprecated. If I have free time and inclination I will unarchive this Repo and create the correct declarations for Gnome DE.

Typescript definitions for GJS - Gnome JavaScript

Generated with GitHub - Gr3q/GIR2TS: TypeScript declaration generator for GObject Introspection. and manually cleaned up.

Usage

This only works on a system where Gnome or some GTK based DM is installed.

Intended to be used with code running off of Gnome JS engine.

It can be included in the project by creatding a declaration file, for example gjs.d.ts:

import "@ci-types/gjs";

In the tsconfig.json file the option exactOptionalPropertyTypes should be set to true as for the construction of a GObject all properties are optional but are not allowed to be undefined.