Grl-0.3
Namespaces
Readme
Grl-0.3
GJS TypeScript type definitions for Grl-0.3 using ts-for-gir v5.2.0.
This package contains type declarations only. It ships no runtime code, so it adds nothing to your program and works with any bundler or none at all.
Install
npm install @girs/grl-0.3
Any package manager works. The package has no dependencies beyond other @girs/*
type packages.
What it exports
| Import | What you get |
|---|---|
@girs/grl-0.3 |
the namespace as a default export, plus the ambient and global declarations |
@girs/grl-0.3/ambient |
only the gi:// module declarations |
@girs/grl-0.3/import |
only the imports.gi declarations |
@girs/grl-0.3/grl-0.3 |
the namespace, without the side-effecting declarations |
Three ways to import
Which one you use depends on how you write imports elsewhere, not on your toolchain.
As a module
import Grl from '@girs/grl-0.3';
As gi://
GJS resolves gi:// at runtime. To give it types, reference the package once, either
from your entry point or from tsconfig.json:
import '@girs/grl-0.3';
{ "include": ["@girs/grl-0.3"] }
Then the runtime spelling type-checks:
import Grl from 'gi://Grl?version=0.3';
Referencing @girs/grl-0.3/ambient instead pulls in these declarations
alone. See ambient modules.
As imports.gi
GJS's global object works the same way, via @girs/grl-0.3/import:
const Grl = imports.gi.Grl;
Building
The declarations need no build step. If you bundle, every bundler works, since there is no runtime code to resolve. The examples show working setups for several.
Other packages
Every pre-generated package is at gjsify/types.