Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

gjs-esm-types

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gjs-esm-types

TypeScript module declarations for GJS ESM modules.

  • 0.0.1
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source
This package provides module declarations for some of the most common GJS modules. With it you will get fully typed imports for the following modules:
  • gi://Atk?version=1.0
  • gi://GLib?version=2.0
  • gi://GModule?version=2.0
  • gi://GObject?version=2.0
  • gi://Gdk?version=3.0
  • gi://Gdk?version=4.0
  • gi://GdkPixbuf?version=2.0
  • gi://Gio?version=2.0
  • gi://Graphene?version=1.0
  • gi://Gsk?version=4.0
  • gi://Gtk?version=3.0
  • gi://Gtk?version=4.0
  • gi://HarfBuzz?version=0.0
  • gi://Pango?version=1.0
  • gi://PangoCairo?version=1.0
  • gi://Soup?version=2.4
  • gi://Soup?version=3.0
  • gi://cairo?version=1.0
  • gi://freetype2?version=2.0
  • gi://xlib?version=2.0

Additionally a module declaration for system module is included as well as some global functions and variables like globalThis.print(), globalThis.imports, globalThis.pkg etc.

Use

  1. Install this package via npm or yarn

  2. Add this package to the tsconfig.json typeRoots:

    {
      "compilerOptions": {
        "typeRoots": ["node_modules/gjs-esm-types", "node_modules/@types"]
      }
    }
    
  3. gi imports should now be correctly typed:

    import Gtk from "gi://Gtk?version=3.0";
    
    const window = new Gtk.Window();
    // Resolved Type - const window: Gtk.Window;
    

Imports without version specifier

This package only provides module declarations for imports with a version specifier. If you want your imports to not include the version, add a .d.ts file in your project and define the module declarations in there, similarly to this:

Example 1 - Gtk

declare module "gi://Gtk" {
  import Gtk from "gi://Gtk?version=4.0";
  export default Gtk;
}

Example 2 - GLib

declare module "gi://GLib" {
  import GLib from "gi://GLib?version=2.0";
  export default GLib;
}

Example 3 - Soup

declare module "gi://Soup" {
  import Soup from "gi://Soup?version=2.4";
  export default Soup;
}

Keywords

FAQs

Package last updated on 13 Mar 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc