@girs/lightdm-1 4.2.0 → 4.4.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 CHANGED
@@ -5,25 +5,25 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/lightdm-1)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for LightDM-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
8
+ GJS TypeScript type definitions for LightDM-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.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/lightdm-1
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 LightDM from '@girs/lightdm-1';
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/lightdm-1` or `@girs/lightdm-1/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/lightdm-1'
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 LightDM from 'gi://LightDM?version=1';
@@ -50,7 +50,7 @@ import LightDM from 'gi://LightDM?version=1';
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/lightdm-1` or `@girs/lightdm-1/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/lightdm-1'
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 LightDM = imports.gi.LightDM;
@@ -77,7 +77,7 @@ const LightDM = imports.gi.LightDM;
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/lightdm-1.d.ts CHANGED
@@ -103,7 +103,7 @@ export namespace LightDM {
103
103
  */
104
104
  QUESTION,
105
105
  /**
106
- * prompt is for secret information. The entered information should be obscured so it can't be publically visible.
106
+ * prompt is for secret information. The entered information should be obscured so it can't be publicly visible.
107
107
  */
108
108
  SECRET,
109
109
  }
@@ -218,7 +218,7 @@ export namespace LightDM {
218
218
  function get_os_version(): string | null;
219
219
 
220
220
  /**
221
- * Get a word descibing the OS version, suitable for checking which version of the OS this greeter is running on.
221
+ * Get a word describing the OS version, suitable for checking which version of the OS this greeter is running on.
222
222
  * e.g. "16.04"
223
223
  * @returns a string (VERSION_ID variable from /etc/os-release) or `null` if not set.
224
224
  */
@@ -673,6 +673,7 @@ export namespace LightDM {
673
673
  /**
674
674
  * Connects the greeter to the display manager. Will block until connected.
675
675
  * @returns `TRUE` if successfully connected
676
+ * @deprecated since 1.11.1: Use `lightdm_greeter_connect_to_daemon_sync()` instead
676
677
  */
677
678
  connect_sync(): boolean;
678
679
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/lightdm-1",
3
- "version": "4.2.0",
3
+ "version": "4.4.0",
4
4
  "description": "GJS TypeScript type definitions for LightDM-1",
5
5
  "type": "module",
6
6
  "module": "lightdm-1.js",
@@ -31,11 +31,11 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.2.0",
35
- "@girs/gio-2.0": "^4.2.0",
36
- "@girs/gobject-2.0": "^4.2.0",
37
- "@girs/glib-2.0": "^4.2.0",
38
- "@girs/gmodule-2.0": "^4.2.0" },
34
+ "@girs/gjs": "^4.4.0",
35
+ "@girs/gio-2.0": "^4.4.0",
36
+ "@girs/gobject-2.0": "^4.4.0",
37
+ "@girs/glib-2.0": "^4.4.0",
38
+ "@girs/gmodule-2.0": "^4.4.0" },
39
39
  "devDependencies": {
40
40
  "typescript": "*"
41
41
  },