@girs/amtk-5

Amtk-5

GJS TypeScript type definitions for Amtk-5, generated from library version 5.0.0 using ts-for-gir v4.0.0-beta.16.

Install

To use this type definitions, install them with NPM:

npm install @girs/amtk-5

Usage

You can import this package into your project like this:

import Amtk from '@girs/amtk-5';

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

index.ts:

import '@girs/amtk-5'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/amtk-5"],
  ...
}

Now you can import the ambient module with TypeScript support:

import Amtk from 'gi://Amtk?version=5';

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

index.ts:

import '@girs/amtk-5'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/amtk-5"],
  ...
}

Now you have also type support for this, too:

const Amtk = imports.gi.Amtk;

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.