@girs/cmenu-3.0 4.1.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.
- package/README.md +8 -8
- package/cmenu-3.0.d.ts +2 -2
- package/package.json +7 -8
package/README.md
CHANGED
|
@@ -5,25 +5,25 @@
|
|
|
5
5
|

|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
GJS TypeScript type definitions for CMenu-3.0
|
|
8
|
+
GJS TypeScript type definitions for CMenu-3.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Install the type definitions with npm:
|
|
13
13
|
```bash
|
|
14
14
|
npm install @girs/cmenu-3.0
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
## Usage
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Import it like any other module:
|
|
20
20
|
```ts
|
|
21
21
|
import CMenu from '@girs/cmenu-3.0';
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
### Ambient Modules
|
|
25
25
|
|
|
26
|
-
|
|
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/cmenu-3.0` or `@girs/cmenu-3.0/ambient` in your `tsconfig` or entry point Typescript file:
|
|
28
28
|
|
|
29
29
|
`index.ts`:
|
|
@@ -42,7 +42,7 @@ import '@girs/cmenu-3.0'
|
|
|
42
42
|
}
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
The ambient module now resolves with types:
|
|
46
46
|
|
|
47
47
|
```ts
|
|
48
48
|
import CMenu from 'gi://CMenu?version=3.0';
|
|
@@ -50,7 +50,7 @@ import CMenu from 'gi://CMenu?version=3.0';
|
|
|
50
50
|
|
|
51
51
|
### Global import
|
|
52
52
|
|
|
53
|
-
|
|
53
|
+
GJS's global `imports.gi` works too, with types.
|
|
54
54
|
For this you need to include `@girs/cmenu-3.0` or `@girs/cmenu-3.0/import` in your `tsconfig` or entry point Typescript file:
|
|
55
55
|
|
|
56
56
|
`index.ts`:
|
|
@@ -69,7 +69,7 @@ import '@girs/cmenu-3.0'
|
|
|
69
69
|
}
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
That form carries types as well:
|
|
73
73
|
|
|
74
74
|
```ts
|
|
75
75
|
const CMenu = imports.gi.CMenu;
|
|
@@ -77,7 +77,7 @@ const CMenu = imports.gi.CMenu;
|
|
|
77
77
|
|
|
78
78
|
### Bundle
|
|
79
79
|
|
|
80
|
-
|
|
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/cmenu-3.0.d.ts
CHANGED
|
@@ -377,7 +377,7 @@ export namespace CMenu {
|
|
|
377
377
|
* the application.
|
|
378
378
|
* @returns a list of content types.
|
|
379
379
|
*/
|
|
380
|
-
get_supported_types(): string[];
|
|
380
|
+
get_supported_types(): string[] | null;
|
|
381
381
|
|
|
382
382
|
/**
|
|
383
383
|
* Launches the application. Passes `files` to the launched application
|
|
@@ -641,7 +641,7 @@ export namespace CMenu {
|
|
|
641
641
|
* the application.
|
|
642
642
|
* @virtual
|
|
643
643
|
*/
|
|
644
|
-
vfunc_get_supported_types(): string[];
|
|
644
|
+
vfunc_get_supported_types(): string[] | null;
|
|
645
645
|
|
|
646
646
|
/**
|
|
647
647
|
* Launches the application. Passes `files` to the launched application
|
package/package.json
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@girs/cmenu-3.0",
|
|
3
|
-
"version": "4.
|
|
4
|
-
"
|
|
5
|
-
"description": "GJS TypeScript type definitions for CMenu-3.0, generated from library version 3.0.0",
|
|
3
|
+
"version": "4.3.0",
|
|
4
|
+
"description": "GJS TypeScript type definitions for CMenu-3.0",
|
|
6
5
|
"type": "module",
|
|
7
6
|
"module": "cmenu-3.0.js",
|
|
8
7
|
"main": "cmenu-3.0.js",
|
|
@@ -32,11 +31,11 @@
|
|
|
32
31
|
"test": "tsc --project tsconfig.json"
|
|
33
32
|
},
|
|
34
33
|
"dependencies": {
|
|
35
|
-
"@girs/gjs": "^4.
|
|
36
|
-
"@girs/gio-2.0": "^4.
|
|
37
|
-
"@girs/gobject-2.0": "^4.
|
|
38
|
-
"@girs/glib-2.0": "^4.
|
|
39
|
-
"@girs/gmodule-2.0": "^4.
|
|
34
|
+
"@girs/gjs": "^4.3.0",
|
|
35
|
+
"@girs/gio-2.0": "^4.3.0",
|
|
36
|
+
"@girs/gobject-2.0": "^4.3.0",
|
|
37
|
+
"@girs/glib-2.0": "^4.3.0",
|
|
38
|
+
"@girs/gmodule-2.0": "^4.3.0" },
|
|
40
39
|
"devDependencies": {
|
|
41
40
|
"typescript": "*"
|
|
42
41
|
},
|