Vpg-1

GJS TypeScript type definitions for Vpg-1, generated from library version 1.0.0 using ts-for-gir v4.0.0-beta.38.

Install

To use this type definitions, install them with NPM:

npm install @girs/vpg-1

Usage

You can import this package into your project like this:

import Vpg from '@girs/vpg-1';

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

index.ts:

import '@girs/vpg-1'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/vpg-1"],
  ...
}

Now you can import the ambient module with TypeScript support:

import Vpg from 'gi://Vpg?version=1';

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

index.ts:

import '@girs/vpg-1'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/vpg-1"],
  ...
}

Now you have also type support for this, too:

const Vpg = imports.gi.Vpg;

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.