Dazzle-1.0

GJS TypeScript type definitions for Dazzle-1.0, generated from library version 3.44.0 using ts-for-gir v3.0.1.

The libdazzle library is a companion library to GObject and Gtk+. It provides various features that we wish were in the underlying library but cannot for various reasons. In most cases, they are wildly out of scope for those libraries. In other cases, our design isn't quite generic enough to work for everyone.

Install

To use this type definitions, install them with NPM:

npm install @girs/dazzle-1.0

Usage

You can import this package into your project like this:

import Dazzle from '@girs/dazzle-1.0';

Or if you prefer CommonJS, you can also use this:

const Dazzle = require('@girs/dazzle-1.0');

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

index.ts:

import '@girs/dazzle-1.0'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/dazzle-1.0"],
  ...
}

Now you can import the ambient module with TypeScript support:

import Dazzle from 'gi://Dazzle?version=1.0';

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

index.ts:

import '@girs/dazzle-1.0'

tsconfig.json:

{
  "compilerOptions": {
    ...
  },
  "include": ["@girs/dazzle-1.0"],
  ...
}

Now you have also type support for this, too:

const Dazzle = imports.gi.Dazzle;

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.