@girs/xed-1.0 4.2.0 → 4.3.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 (2) hide show
  1. package/README.md +8 -8
  2. package/package.json +16 -16
package/README.md CHANGED
@@ -5,25 +5,25 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/xed-1.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Xed-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
8
+ GJS TypeScript type definitions for Xed-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
9
9
 
10
10
  ## Install
11
11
 
12
- To use this type definitions, install them with NPM:
12
+ Install the type definitions with npm:
13
13
  ```bash
14
14
  npm install @girs/xed-1.0
15
15
  ```
16
16
 
17
17
  ## Usage
18
18
 
19
- You can import this package into your project like this:
19
+ Import it like any other module:
20
20
  ```ts
21
21
  import Xed from '@girs/xed-1.0';
22
22
  ```
23
23
 
24
24
  ### Ambient Modules
25
25
 
26
- 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.
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
27
  For this you need to include `@girs/xed-1.0` or `@girs/xed-1.0/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/xed-1.0'
42
42
  }
43
43
  ```
44
44
 
45
- Now you can import the ambient module with TypeScript support:
45
+ The ambient module now resolves with types:
46
46
 
47
47
  ```ts
48
48
  import Xed from 'gi://Xed?version=1.0';
@@ -50,7 +50,7 @@ import Xed from 'gi://Xed?version=1.0';
50
50
 
51
51
  ### Global import
52
52
 
53
- You can also import the module with Typescript support using the global `imports.gi` object of GJS.
53
+ GJS's global `imports.gi` works too, with types.
54
54
  For this you need to include `@girs/xed-1.0` or `@girs/xed-1.0/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/xed-1.0'
69
69
  }
70
70
  ```
71
71
 
72
- Now you have also type support for this, too:
72
+ That form carries types as well:
73
73
 
74
74
  ```ts
75
75
  const Xed = imports.gi.Xed;
@@ -77,7 +77,7 @@ const Xed = imports.gi.Xed;
77
77
 
78
78
  ### Bundle
79
79
 
80
- 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).
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.
81
81
 
82
82
  ## Other packages
83
83
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/xed-1.0",
3
- "version": "4.2.0",
3
+ "version": "4.3.0",
4
4
  "description": "GJS TypeScript type definitions for Xed-1.0",
5
5
  "type": "module",
6
6
  "module": "xed-1.0.js",
@@ -36,21 +36,21 @@
36
36
  "test": "tsc --project tsconfig.json"
37
37
  },
38
38
  "dependencies": {
39
- "@girs/gjs": "^4.2.0",
40
- "@girs/gtksource-4": "^4.2.0",
41
- "@girs/gtk-3.0": "^4.2.0",
42
- "@girs/xlib-2.0": "^4.2.0",
43
- "@girs/gdk-3.0": "^4.2.0",
44
- "@girs/cairo-1.0": "^4.2.0",
45
- "@girs/gobject-2.0": "^4.2.0",
46
- "@girs/glib-2.0": "^4.2.0",
47
- "@girs/pango-1.0": "^4.2.0",
48
- "@girs/harfbuzz-0.0": "^4.2.0",
49
- "@girs/freetype2-2.0": "^4.2.0",
50
- "@girs/gio-2.0": "^4.2.0",
51
- "@girs/gmodule-2.0": "^4.2.0",
52
- "@girs/gdkpixbuf-2.0": "^4.2.0",
53
- "@girs/atk-1.0": "^4.2.0" },
39
+ "@girs/gjs": "^4.3.0",
40
+ "@girs/gtksource-4": "^4.3.0",
41
+ "@girs/gtk-3.0": "^4.3.0",
42
+ "@girs/xlib-2.0": "^4.3.0",
43
+ "@girs/gdk-3.0": "^4.3.0",
44
+ "@girs/cairo-1.0": "^4.3.0",
45
+ "@girs/gobject-2.0": "^4.3.0",
46
+ "@girs/glib-2.0": "^4.3.0",
47
+ "@girs/pango-1.0": "^4.3.0",
48
+ "@girs/harfbuzz-0.0": "^4.3.0",
49
+ "@girs/freetype2-2.0": "^4.3.0",
50
+ "@girs/gio-2.0": "^4.3.0",
51
+ "@girs/gmodule-2.0": "^4.3.0",
52
+ "@girs/gdkpixbuf-2.0": "^4.3.0",
53
+ "@girs/atk-1.0": "^4.3.0" },
54
54
  "devDependencies": {
55
55
  "typescript": "*"
56
56
  },