@girs/gdkwin32-4.0 4.4.0 → 4.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +36 -41
  2. package/gdkwin32-4.0.d.ts +9 -6
  3. package/package.json +14 -14
package/README.md CHANGED
@@ -4,82 +4,77 @@
4
4
  ![version](https://img.shields.io/npm/v/@girs/gdkwin32-4.0)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gdkwin32-4.0)
6
6
 
7
+ GJS TypeScript type definitions for GdkWin32-4.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.6.0.
7
8
 
8
- GJS TypeScript type definitions for GdkWin32-4.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
9
+ This package contains type declarations only. It ships no runtime code, so it adds
10
+ nothing to your program and works with any bundler or none at all.
9
11
 
10
12
  ## Install
11
13
 
12
- Install the type definitions with npm:
13
14
  ```bash
14
15
  npm install @girs/gdkwin32-4.0
15
16
  ```
16
17
 
17
- ## Usage
18
+ Any package manager works. The package has no dependencies beyond other `@girs/*`
19
+ type packages.
20
+
21
+ ## What it exports
22
+
23
+ | Import | What you get |
24
+ |---|---|
25
+ | `@girs/gdkwin32-4.0` | the namespace as a default export, plus the ambient and global declarations |
26
+ | `@girs/gdkwin32-4.0/ambient` | only the `gi://` module declarations |
27
+ | `@girs/gdkwin32-4.0/import` | only the `imports.gi` declarations |
28
+ | `@girs/gdkwin32-4.0/gdkwin32-4.0` | the namespace, without the side-effecting declarations |
29
+
30
+ ## Three ways to import
31
+
32
+ Which one you use depends on how you write imports elsewhere, not on your toolchain.
33
+
34
+ ### As a module
18
35
 
19
- Import it like any other module:
20
36
  ```ts
21
37
  import GdkWin32 from '@girs/gdkwin32-4.0';
22
38
  ```
23
39
 
24
- ### Ambient Modules
40
+ ### As `gi://`
25
41
 
26
- [Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
27
- For this you need to include `@girs/gdkwin32-4.0` or `@girs/gdkwin32-4.0/ambient` in your `tsconfig` or entry point Typescript file:
42
+ GJS resolves `gi://` at runtime. To give it types, reference the package once, either
43
+ from your entry point or from `tsconfig.json`:
28
44
 
29
- `index.ts`:
30
45
  ```ts
31
- import '@girs/gdkwin32-4.0'
46
+ import '@girs/gdkwin32-4.0';
32
47
  ```
33
48
 
34
- `tsconfig.json`:
35
49
  ```json
36
- {
37
- "compilerOptions": {
38
- ...
39
- },
40
- "include": ["@girs/gdkwin32-4.0"],
41
- ...
42
- }
50
+ { "include": ["@girs/gdkwin32-4.0"] }
43
51
  ```
44
52
 
45
- The ambient module now resolves with types:
53
+ Then the runtime spelling type-checks:
46
54
 
47
55
  ```ts
48
56
  import GdkWin32 from 'gi://GdkWin32?version=4.0';
49
57
  ```
50
58
 
51
- ### Global import
52
-
53
- GJS's global `imports.gi` works too, with types.
54
- For this you need to include `@girs/gdkwin32-4.0` or `@girs/gdkwin32-4.0/import` in your `tsconfig` or entry point Typescript file:
59
+ Referencing `@girs/gdkwin32-4.0/ambient` instead pulls in these declarations
60
+ alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
55
61
 
56
- `index.ts`:
57
- ```ts
58
- import '@girs/gdkwin32-4.0'
59
- ```
60
-
61
- `tsconfig.json`:
62
- ```json
63
- {
64
- "compilerOptions": {
65
- ...
66
- },
67
- "include": ["@girs/gdkwin32-4.0"],
68
- ...
69
- }
70
- ```
62
+ ### As `imports.gi`
71
63
 
72
- That form carries types as well:
64
+ GJS's global object works the same way, via `@girs/gdkwin32-4.0/import`:
73
65
 
74
66
  ```ts
75
67
  const GdkWin32 = imports.gi.GdkWin32;
76
68
  ```
77
69
 
78
- ### Bundle
70
+ ## Building
79
71
 
80
- Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
72
+ The declarations need no build step. If you bundle, every bundler works, since there is
73
+ no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
74
+ show working setups for several.
81
75
 
82
76
  ## Other packages
83
77
 
84
- All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
78
+ Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
79
+
85
80
 
package/gdkwin32-4.0.d.ts CHANGED
@@ -42,16 +42,16 @@ export namespace GdkWin32 {
42
42
  * is not Windows, the Windows version is not recent enough, or it was explicitly
43
43
  * disabled at compile- or runtime
44
44
  */
45
- NOT_AVAILABLE,
45
+ NOT_AVAILABLE = 0,
46
46
  /**
47
47
  * The requested format is not supported
48
48
  */
49
- UNSUPPORTED_FORMAT,
49
+ UNSUPPORTED_FORMAT = 1,
50
50
  /**
51
51
  * GTK failed to create the resource for other
52
52
  * reasons
53
53
  */
54
- CREATION_FAILED,
54
+ CREATION_FAILED = 2,
55
55
  }
56
56
 
57
57
 
@@ -63,11 +63,11 @@ export namespace GdkWin32 {
63
63
  /**
64
64
  * event not handled, continue processing.
65
65
  */
66
- CONTINUE,
66
+ CONTINUE = 0,
67
67
  /**
68
68
  * event handled, terminate processing.
69
69
  */
70
- REMOVE,
70
+ REMOVE = 1,
71
71
  }
72
72
 
73
73
 
@@ -91,7 +91,7 @@ export namespace GdkWin32 {
91
91
 
92
92
  namespace D3D12Texture {
93
93
  // Signal signatures
94
- interface SignalSignatures extends Gdk.Texture.SignalSignatures {
94
+ interface SignalSignatures extends Gdk.Texture.SignalSignatures, Gdk.Paintable.SignalSignatures {
95
95
  "notify::color-state": (pspec: GObject.ParamSpec) => void;
96
96
  "notify::height": (pspec: GObject.ParamSpec) => void;
97
97
  "notify::width": (pspec: GObject.ParamSpec) => void;
@@ -442,6 +442,7 @@ export namespace GdkWin32 {
442
442
  * @param size an integer.
443
443
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
444
444
  * @returns a {@link Gio.InputStream} to read the icon from.
445
+ * @throws GLib.Error
445
446
  */
446
447
  load(size: number, cancellable: Gio.Cancellable | null): [Gio.InputStream, string];
447
448
 
@@ -478,6 +479,7 @@ export namespace GdkWin32 {
478
479
  * Finishes an asynchronous icon load started in `g_loadable_icon_load_async()`.
479
480
  * @param res a {@link Gio.AsyncResult}.
480
481
  * @returns a {@link Gio.InputStream} to read the icon from.
482
+ * @throws GLib.Error
481
483
  */
482
484
  load_finish(res: Gio.AsyncResult): [Gio.InputStream, string];
483
485
 
@@ -690,6 +692,7 @@ export namespace GdkWin32 {
690
692
  * @param data user data to pass to the destroy function
691
693
  * @returns a newly built {@link Gdk.Texture} or `NULL` if the format is not supported
692
694
  * @since 4.20
695
+ * @throws GLib.Error
693
696
  */
694
697
  build(data: null): Gdk.Texture | null;
695
698
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gdkwin32-4.0",
3
- "version": "4.4.0",
3
+ "version": "4.6.0",
4
4
  "description": "GJS TypeScript type definitions for GdkWin32-4.0",
5
5
  "type": "module",
6
6
  "module": "gdkwin32-4.0.js",
@@ -31,19 +31,19 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.4.0",
35
- "@girs/win32-1.0": "^4.4.0",
36
- "@girs/gdk-4.0": "^4.4.0",
37
- "@girs/cairo-1.0": "^4.4.0",
38
- "@girs/gobject-2.0": "^4.4.0",
39
- "@girs/glib-2.0": "^4.4.0",
40
- "@girs/pangocairo-1.0": "^4.4.0",
41
- "@girs/pango-1.0": "^4.4.0",
42
- "@girs/harfbuzz-0.0": "^4.4.0",
43
- "@girs/freetype2-2.0": "^4.4.0",
44
- "@girs/gio-2.0": "^4.4.0",
45
- "@girs/gmodule-2.0": "^4.4.0",
46
- "@girs/gdkpixbuf-2.0": "^4.4.0" },
34
+ "@girs/gjs": "^4.6.0",
35
+ "@girs/win32-1.0": "^4.6.0",
36
+ "@girs/gdk-4.0": "^4.6.0",
37
+ "@girs/cairo-1.0": "^4.6.0",
38
+ "@girs/gobject-2.0": "^4.6.0",
39
+ "@girs/glib-2.0": "^4.6.0",
40
+ "@girs/pangocairo-1.0": "^4.6.0",
41
+ "@girs/pango-1.0": "^4.6.0",
42
+ "@girs/harfbuzz-0.0": "^4.6.0",
43
+ "@girs/freetype2-2.0": "^4.6.0",
44
+ "@girs/gio-2.0": "^4.6.0",
45
+ "@girs/gmodule-2.0": "^4.6.0",
46
+ "@girs/gdkpixbuf-2.0": "^4.6.0" },
47
47
  "devDependencies": {
48
48
  "typescript": "*"
49
49
  },