@girs/xlib-2.0 - npm Package Compare versions

Comparing version 2.0.0-3.0.0-beta.14 to 2.0.0-3.0.0-beta.15

package.json

 {
   "name": "@girs/xlib-2.0",
-  "version": "2.0.0-3.0.0-beta.14",
+  "version": "2.0.0-3.0.0-beta.15",
   "description": "GJS TypeScript type definitions for xlib-2.0, generated from library version 2.0.0",
@@ -15,2 +15,4 @@ "type": "module",
   "exports": {
+    "./ambient": "./xlib-2.0-ambient.d.ts",
+    "./import": "./xlib-2.0-import.d.ts",
     ".": {
@@ -33,3 +35,3 @@ "import": {
   "dependencies": {
-    "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.14"
+    "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.15"
   },
@@ -36,0 +38,0 @@ "devDependencies": {

README.md

 
 # xlib-2.0
 
-GJS TypeScript type definitions for xlib-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0-beta.14.
+GJS TypeScript type definitions for xlib-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0-beta.15.
 
 ## Install
 
-To use this type definitions, install them with NPM like this:
+To use this type definitions, install them with NPM:
 ```bash
@@ -25,8 +25,59 @@ npm install @girs/xlib-2.0
 
-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:
+### Ambient Modules
 
+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.
+For this you need to include `@girs/xlib-2.0` or `@girs/xlib-2.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
 ```ts
+import '@girs/xlib-2.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/xlib-2.0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
 import xlib from 'gi://xlib?version=2.0';
 ```
 
+
+### Global import
+
+You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+For this you need to include `@girs/xlib-2.0` or `@girs/xlib-2.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/xlib-2.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/xlib-2.0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const xlib = imports.gi.xlib;
+```
+
+### Bundle
+
 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).
@@ -36,2 +87,3 @@
 
-All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

tsconfig.doc.json

@@ -20,1 +20,3 @@ {
 }
+
+

xlib-2.0.d.ts

@@ -8,2 +8,5 @@
  */
+
+import './xlib-2.0-ambient.d.ts';
+import './xlib-2.0-import.d.ts';
 /**
@@ -10,0 +13,0 @@ * xlib-2.0

xlib-2.0.js

@@ -9,1 +9,3 @@
 
+
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9225

increased by18.8%

Number of package files

9

increased by28.57%

Lines of code

140

increased by13.82%

Number of lines in readme file

88

increased by151.43%

Dependency changes

• Updated@girs/gobject-2.0@^2.76.1-3.0.0-beta.15