Skip to content
/ types Public

Generated Typescript type definition files for GObject Introspection (GJS and node-gtk)

Notifications You must be signed in to change notification settings

gjsify/types

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GObject Introspection TypeScript Type Definitions

This repository contains TypeScript type definition files for GObject introspection libraries targeting GJS and node-gtk. These types are generated using ts-for-gir, a powerful TypeScript type definition generator for GObject Introspection GIR files.

Developers can now benefit from TypeScript's strong typing and improved code navigation, making it easier to build robust and powerful applications with GJS.

Available Type Definitions

The pre-generated type definitions can be found in the types repository. The repository includes types for various GObject Introspection modules, including:

The types are also available pre-generated for Node.js, see for this node-gtk, node-gtk-4.0, node-adw-1, node-gio-2.0 and so on..

Usage

To use these type definitions in your GJS project, you can install them via npm or yarn:

npm install @girs/gjs @girs/gtk-4.0 --save
# or
yarn add @girs/gjs @girs/gtk-4.0

Reporting Issues and Feature Requests

This repository hosts the TypeScript type definitions generated by ts-for-gir, a tool for generating TypeScript definitions from GObject introspection files. As such, it only contains the generated TypeScript types and does not include the generation logic itself.

Where to Report Issues?

If you encounter any issues with the types, or have suggestions or feature requests for the generation process, please direct them to the ts-for-gir repository. This helps us keep track of the generation logic and make improvements where necessary.

🔗 Report Issues Here: ts-for-gir Issues

By concentrating issues related to the generation of TypeScript types in the ts-for-gir repository, we can more effectively address bugs, enhance the generator, and discuss potential improvements.

Contributions

Contributions to both the type definitions and the generator are welcome. For contributions specific to the TypeScript types, please make sure any changes are compatible with the generator's output to ensure consistency across updates.

Thank you for your support and contributions!

Releases

No releases published

Packages

No packages published