# Gck-2

![version](https://img.shields.io/npm/v/@girs/gck-2)
![downloads/week](https://img.shields.io/npm/dw/@girs/gck-2)

GJS TypeScript type definitions for Gck-2, generated from library version 4.4.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.0.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

```bash
npm install @girs/gck-2
```

Any package manager works. The package has no dependencies beyond other `@girs/*`
type packages.

## What it exports

| Import | What you get |
|---|---|
| `@girs/gck-2` | the namespace as a default export, plus the ambient and global declarations |
| `@girs/gck-2/ambient` | only the `gi://` module declarations |
| `@girs/gck-2/import` | only the `imports.gi` declarations |
| `@girs/gck-2/gck-2` | 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

```ts
import Gck from '@girs/gck-2';
```

### As `gi://`

GJS resolves `gi://` at runtime. To give it types, reference the package once, either
from your entry point or from `tsconfig.json`:

```ts
import '@girs/gck-2';
```

```json
{ "include": ["@girs/gck-2"] }
```

Then the runtime spelling type-checks:

```ts
import Gck from 'gi://Gck?version=2';
```

Referencing `@girs/gck-2/ambient` instead pulls in these declarations
alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).

### As `imports.gi`

GJS's global object works the same way, via `@girs/gck-2/import`:

```ts
const Gck = imports.gi.Gck;
```

## Building

The declarations need no build step. If you bundle, every bundler works, since there is
no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
show working setups for several.

## Other packages

Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).