@girs/devhelp-3.0 3.0.0-3.0.0-beta.14 → 3.0.0-3.0.0-beta.15

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 (9) hide show
  1. package/README.md +56 -4
  2. package/devhelp-3.0-ambient.d.ts +13 -0
  3. package/devhelp-3.0-import.d.ts +13 -0
  4. package/devhelp-3.0.cjs +2 -0
  5. package/devhelp-3.0.d.cts +3 -0
  6. package/devhelp-3.0.d.ts +3 -0
  7. package/devhelp-3.0.js +2 -0
  8. package/package.json +19 -17
  9. package/tsconfig.doc.json +2 -0
package/README.md CHANGED
@@ -1,11 +1,11 @@
1
1
 
2
2
  # Devhelp-3.0
3
3
 
4
- GJS TypeScript type definitions for Devhelp-3.0, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0-beta.14.
4
+ GJS TypeScript type definitions for Devhelp-3.0, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0-beta.15.
5
5
 
6
6
  ## Install
7
7
 
8
- To use this type definitions, install them with NPM like this:
8
+ To use this type definitions, install them with NPM:
9
9
  ```bash
10
10
  npm install @girs/devhelp-3.0
11
11
  ```
@@ -22,14 +22,66 @@ Or if you prefer CommonJS, you can also use this:
22
22
  const Devhelp = require('@girs/devhelp-3.0');
23
23
  ```
24
24
 
25
- If you use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules), you can also import this module like you would do this in JavaScript:
25
+ ### Ambient Modules
26
+
27
+ You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
28
+ For this you need to include `@girs/devhelp-3.0` or `@girs/devhelp-3.0/ambient` in your `tsconfig` or entry point Typescript file:
29
+
30
+ `index.ts`:
31
+ ```ts
32
+ import '@girs/devhelp-3.0'
33
+ ```
34
+
35
+ `tsconfig.json`:
36
+ ```json
37
+ {
38
+ "compilerOptions": {
39
+ ...
40
+ },
41
+ "include": ["@girs/devhelp-3.0"],
42
+ ...
43
+ }
44
+ ```
45
+
46
+ Now you can import the ambient module with TypeScript support:
26
47
 
27
48
  ```ts
28
49
  import Devhelp from 'gi://Devhelp?version=3.0';
29
50
  ```
30
51
 
52
+
53
+ ### Global import
54
+
55
+ You can also import the module with Typescript support using the global `imports.gi` object of GJS.
56
+ For this you need to include `@girs/devhelp-3.0` or `@girs/devhelp-3.0/import` in your `tsconfig` or entry point Typescript file:
57
+
58
+ `index.ts`:
59
+ ```ts
60
+ import '@girs/devhelp-3.0'
61
+ ```
62
+
63
+ `tsconfig.json`:
64
+ ```json
65
+ {
66
+ "compilerOptions": {
67
+ ...
68
+ },
69
+ "include": ["@girs/devhelp-3.0"],
70
+ ...
71
+ }
72
+ ```
73
+
74
+ Now you have also type support for this, too:
75
+
76
+ ```ts
77
+ const Devhelp = imports.gi.Devhelp;
78
+ ```
79
+
80
+ ### Bundle
81
+
31
82
  Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
32
83
 
33
84
  ## Other packages
34
85
 
35
- All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
86
+ All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
87
+
package/devhelp-3.0-ambient.d.ts ADDED
@@ -0,0 +1,13 @@
1
+
2
+
3
+ declare module 'gi://Devhelp?version=3.0' {
4
+ import Devhelp30 from '@girs/devhelp-3.0';
5
+ export default Devhelp30;
6
+ }
7
+
8
+ declare module 'gi://Devhelp' {
9
+ import Devhelp30 from '@girs/devhelp-3.0';
10
+ export default Devhelp30;
11
+ }
12
+
13
+
package/devhelp-3.0-import.d.ts ADDED
@@ -0,0 +1,13 @@
1
+
2
+
3
+ import Devhelp30 from '@girs/devhelp-3.0';
4
+
5
+ declare global {
6
+ export interface GjsGiImports {
7
+ Devhelp: typeof Devhelp30;
8
+ }
9
+ }
10
+
11
+ export default GjsGiImports;
12
+
13
+
package/devhelp-3.0.cjs CHANGED
@@ -7,3 +7,5 @@
7
7
 
8
8
 
9
9
 
10
+
11
+
package/devhelp-3.0.d.cts CHANGED
@@ -5,6 +5,9 @@
5
5
  * These type definitions are automatically generated, do not edit them by hand.
6
6
  * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
7
7
  */
8
+
9
+ import './devhelp-3.0-ambient.d.ts';
10
+ import './devhelp-3.0-import.d.ts';
8
11
  /**
9
12
  * Devhelp-3.0
10
13
  */
package/devhelp-3.0.d.ts CHANGED
@@ -5,6 +5,9 @@
5
5
  * These type definitions are automatically generated, do not edit them by hand.
6
6
  * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
7
7
  */
8
+
9
+ import './devhelp-3.0-ambient.d.ts';
10
+ import './devhelp-3.0-import.d.ts';
8
11
  /**
9
12
  * Devhelp-3.0
10
13
  */
package/devhelp-3.0.js CHANGED
@@ -6,3 +6,5 @@
6
6
  export default Devhelp;
7
7
 
8
8
 
9
+
10
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/devhelp-3.0",
3
- "version": "3.0.0-3.0.0-beta.14",
3
+ "version": "3.0.0-3.0.0-beta.15",
4
4
  "description": "GJS TypeScript type definitions for Devhelp-3.0, generated from library version 3.0.0",
5
5
  "type": "module",
6
6
  "module": "devhelp-3.0.js",
@@ -12,6 +12,8 @@
12
12
  "tsconfig": "./tsconfig.doc.json"
13
13
  },
14
14
  "exports": {
15
+ "./ambient": "./devhelp-3.0-ambient.d.ts",
16
+ "./import": "./devhelp-3.0-import.d.ts",
15
17
  ".": {
16
18
  "import": {
17
19
  "types": "./devhelp-3.0.d.ts",
@@ -29,22 +31,22 @@
29
31
  "test:cjs": "tsc --noEmit devhelp-3.0.d.cts"
30
32
  },
31
33
  "dependencies": {
32
- "@girs/atk-1.0": "^2.45.1-3.0.0-beta.14",
33
- "@girs/cairo-1.0": "^1.0.0-3.0.0-beta.14",
34
- "@girs/freetype2-2.0": "^2.0.0-3.0.0-beta.14",
35
- "@girs/gdk-3.0": "^3.24.36-3.0.0-beta.14",
36
- "@girs/gdkpixbuf-2.0": "^2.0.0-3.0.0-beta.14",
37
- "@girs/gio-2.0": "^2.76.1-3.0.0-beta.14",
38
- "@girs/glib-2.0": "^2.76.1-3.0.0-beta.14",
39
- "@girs/gmodule-2.0": "^2.0.0-3.0.0-beta.14",
40
- "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.14",
41
- "@girs/gtk-3.0": "^3.24.36-3.0.0-beta.14",
42
- "@girs/harfbuzz-0.0": "^6.0.0-3.0.0-beta.14",
43
- "@girs/javascriptcore-4.1": "^2.40.0-3.0.0-beta.14",
44
- "@girs/pango-1.0": "^1.50.13-3.0.0-beta.14",
45
- "@girs/soup-3.0": "^3.3.1-3.0.0-beta.14",
46
- "@girs/webkit2-4.1": "^2.40.0-3.0.0-beta.14",
47
- "@girs/xlib-2.0": "^2.0.0-3.0.0-beta.14"
34
+ "@girs/webkit2-4.1": "^2.40.0-3.0.0-beta.15",
35
+ "@girs/soup-3.0": "^3.3.1-3.0.0-beta.15",
36
+ "@girs/gio-2.0": "^2.76.1-3.0.0-beta.15",
37
+ "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.15",
38
+ "@girs/glib-2.0": "^2.76.1-3.0.0-beta.15",
39
+ "@girs/javascriptcore-4.1": "^2.40.0-3.0.0-beta.15",
40
+ "@girs/gtk-3.0": "^3.24.36-3.0.0-beta.15",
41
+ "@girs/xlib-2.0": "^2.0.0-3.0.0-beta.15",
42
+ "@girs/gdk-3.0": "^3.24.36-3.0.0-beta.15",
43
+ "@girs/cairo-1.0": "^1.0.0-3.0.0-beta.15",
44
+ "@girs/pango-1.0": "^1.50.13-3.0.0-beta.15",
45
+ "@girs/harfbuzz-0.0": "^6.0.0-3.0.0-beta.15",
46
+ "@girs/freetype2-2.0": "^2.0.0-3.0.0-beta.15",
47
+ "@girs/gdkpixbuf-2.0": "^2.0.0-3.0.0-beta.15",
48
+ "@girs/gmodule-2.0": "^2.0.0-3.0.0-beta.15",
49
+ "@girs/atk-1.0": "^2.45.1-3.0.0-beta.15"
48
50
  },
49
51
  "devDependencies": {
50
52
  "typescript": "^5.0.4"
package/tsconfig.doc.json CHANGED
@@ -17,3 +17,5 @@
17
17
  },
18
18
  "include": ["./devhelp-3.0.d.ts"]
19
19
  }
20
+
21
+