Peas-2

GJS TypeScript type definitions for Peas-2, generated from library version 2.0.0 using ts-for-gir v4.0.2.

Install

To use this type definitions, install them with NPM:

npm install @girs/peas-2

Usage

You can import this package into your project like this:

import Peas from '@girs/peas-2';

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

index.ts:

import '@girs/peas-2'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/peas-2"],
  ...
}

Now you can import the ambient module with TypeScript support:

import Peas from 'gi://Peas?version=2';

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

index.ts:

import '@girs/peas-2'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/peas-2"],
  ...
}

Now you have also type support for this, too:

const Peas = imports.gi.Peas;

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.