Shell-18

GJS TypeScript type definitions for Shell-18, generated from library version 18.0.0 using ts-for-gir v4.0.0-rc.7.

Install

To use this type definitions, install them with NPM:

npm install @girs/shell-18
Copy

Usage

You can import this package into your project like this:

import Shell from '@girs/shell-18';
Copy

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/shell-18 or @girs/shell-18/ambient in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/shell-18'
Copy

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/shell-18"],
  ...
}
Copy

Now you can import the ambient module with TypeScript support:

import Shell from 'gi://Shell?version=18';
Copy

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/shell-18 or @girs/shell-18/import in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/shell-18'
Copy

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/shell-18"],
  ...
}
Copy

Now you have also type support for this, too:

const Shell = imports.gi.Shell;
Copy

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.