Soup-3.0

GJS TypeScript type definitions for Soup-3.0, generated from library version 3.6.6 using ts-for-gir v4.0.0-beta.40.

Install

To use this type definitions, install them with NPM:

npm install @girs/soup-3.0
Copy

Usage

You can import this package into your project like this:

import Soup from '@girs/soup-3.0';
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/soup-3.0 or @girs/soup-3.0/ambient in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/soup-3.0'
Copy

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/soup-3.0"],
  ...
}
Copy

Now you can import the ambient module with TypeScript support:

import Soup from 'gi://Soup?version=3.0';
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/soup-3.0 or @girs/soup-3.0/import in your tsconfig or entry point Typescript file:

index.ts:

import '@girs/soup-3.0'
Copy

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/soup-3.0"],
  ...
}
Copy

Now you have also type support for this, too:

const Soup = imports.gi.Soup;
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.