@girs/gmodule-2.0

GModule-2.0

GJS TypeScript type definitions for GModule-2.0, generated from library version 2.0.0 using ts-for-gir v3.0.1.

Portable method for dynamically loading 'plug-ins'

Install

To use this type definitions, install them with NPM:

npm install @girs/gmodule-2.0

Usage

You can import this package into your project like this:

import GModule from '@girs/gmodule-2.0';

Or if you prefer CommonJS, you can also use this:

const GModule = require('@girs/gmodule-2.0');

Ambient Modules

You can also use ambient modules to import this module like you would do this in JavaScript. For this you need to include @girs/gmodule-2.0 or @girs/gmodule-2.0/ambient in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/gmodule-2.0'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/gmodule-2.0"],
  ...
}

Now you can import the ambient module with TypeScript support:

import GModule from 'gi://GModule?version=2.0';

Global import

You can also import the module with Typescript support using the global imports.gi object of GJS. For this you need to include @girs/gmodule-2.0 or @girs/gmodule-2.0/import in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/gmodule-2.0'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/gmodule-2.0"],
  ...
}

Now you have also type support for this, too:

const GModule = imports.gi.GModule;

Bundle

Depending on your project configuration, it is recommended to use a bundler like esbuild. You can find examples using different bundlers here.

Other packages

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