@girs/giowin32-2.0 2.0.0-4.0.0-rc.1

package/README.md

@@ -0,0 +1,85 @@
+
+# GioWin32-2.0
+
+![version](https://img.shields.io/npm/v/@girs/giowin32-2.0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/giowin32-2.0)
+
+
+GJS TypeScript type definitions for GioWin32-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-rc.1.
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/giowin32-2.0
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import GioWin32 from '@girs/giowin32-2.0';
+```
+
+### 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/giowin32-2.0` or `@girs/giowin32-2.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/giowin32-2.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/giowin32-2.0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import GioWin32 from 'gi://GioWin32?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/giowin32-2.0` or `@girs/giowin32-2.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/giowin32-2.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/giowin32-2.0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const GioWin32 = imports.gi.GioWin32;
+```
+
+### 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).
+
+## Other packages
+
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/giowin32-2.0-ambient.d.ts

@@ -0,0 +1,9 @@
+declare module 'gi://GioWin32?version=2.0' {
+    import GioWin3220 from '@girs/giowin32-2.0';
+    export default GioWin3220;
+}
+
+declare module 'gi://GioWin32' {
+    import GioWin3220 from 'gi://GioWin32?version=2.0';
+    export default GioWin3220;
+}

package/giowin32-2.0-ambient.js

@@ -0,0 +1,2 @@
+export {}
+

package/giowin32-2.0-import.d.ts

@@ -0,0 +1,9 @@
+import type GioWin3220 from '@girs/giowin32-2.0';
+
+declare global {
+    export interface GjsGiImports {
+        GioWin32: typeof GioWin3220;
+    }
+}
+
+export default GjsGiImports;

package/giowin32-2.0-import.js

@@ -0,0 +1,3 @@
+const gi = globalThis.imports?.gi || {};
+export default gi;
+

package/giowin32-2.0.d.ts

@@ -0,0 +1,312 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import '@girs/gjs';
+
+// Module dependencies
+import type Gio from '@girs/gio-2.0';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+import type GModule from '@girs/gmodule-2.0';
+
+export namespace GioWin32 {
+    /**
+     * GioWin32-2.0
+     */
+
+    /**
+     * If `registry_key` is `null` then the default path
+     * `HKEY_CURRENT_USER\Software\GSettings` is used.
+     * @param registry_key the path to the registry key where                settings are stored, or `null`.
+     * @returns a registry-backed {@link Gio.SettingsBackend}
+     * @since 2.78
+     */
+    function registry_settings_backend_new(registry_key?: string | null): Gio.SettingsBackend;
+    namespace InputStream {
+        // Signal signatures
+        interface SignalSignatures extends Gio.InputStream.SignalSignatures {
+            'notify::close-handle': (pspec: GObject.ParamSpec) => void;
+            'notify::handle': (pspec: GObject.ParamSpec) => void;
+        }
+
+        // Constructor properties interface
+
+        interface ConstructorProps extends Gio.InputStream.ConstructorProps {
+            close_handle: boolean;
+            closeHandle: boolean;
+            handle: any;
+        }
+    }
+
+    /**
+     * {@link GioWin32.InputStream} implements {@link Gio.InputStream} for reading from a
+     * Windows file handle.
+     *
+     * Note that `<gio/gwin32inputstream.h>` belongs to the Windows-specific GIO
+     * interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file
+     * when using it.
+     * @gir-type Class
+     */
+    class InputStream extends Gio.InputStream {
+        static $gtype: GObject.GType<InputStream>;
+
+        // Properties
+
+        /**
+         * Whether to close the file handle when the stream is closed.
+         * @since 2.26
+         */
+        get close_handle(): boolean;
+        set close_handle(val: boolean);
+        /**
+         * Whether to close the file handle when the stream is closed.
+         * @since 2.26
+         */
+        get closeHandle(): boolean;
+        set closeHandle(val: boolean);
+        /**
+         * The handle that the stream reads from.
+         * @since 2.26
+         * @construct-only
+         */
+        get handle(): any;
+
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: InputStream.SignalSignatures;
+
+        // Constructors
+
+        constructor(properties?: Partial<InputStream.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](handle: any | null, close_handle: boolean): InputStream;
+
+        // Signals
+
+        /** @signal */
+        connect<K extends keyof InputStream.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, InputStream.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        /** @signal */
+        connect_after<K extends keyof InputStream.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, InputStream.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        /** @signal */
+        emit<K extends keyof InputStream.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<InputStream.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
+        // Methods
+
+        /**
+         * Returns whether the handle of `stream` will be
+         * closed when the stream is closed.
+         * @returns `true` if the handle is closed when done
+         */
+        get_close_handle(): boolean;
+        /**
+         * Return the Windows file handle that the stream reads from.
+         * @returns The file handle of `stream`
+         */
+        get_handle(): any | null;
+        /**
+         * Sets whether the handle of `stream` shall be closed
+         * when the stream is closed.
+         * @param close_handle `true` to close the handle when done
+         */
+        set_close_handle(close_handle: boolean): void;
+    }
+
+    namespace OutputStream {
+        // Signal signatures
+        interface SignalSignatures extends Gio.OutputStream.SignalSignatures {
+            'notify::close-handle': (pspec: GObject.ParamSpec) => void;
+            'notify::handle': (pspec: GObject.ParamSpec) => void;
+        }
+
+        // Constructor properties interface
+
+        interface ConstructorProps extends Gio.OutputStream.ConstructorProps {
+            close_handle: boolean;
+            closeHandle: boolean;
+            handle: any;
+        }
+    }
+
+    /**
+     * {@link GioWin32.OutputStream} implements {@link Gio.OutputStream} for writing to a
+     * Windows file handle.
+     *
+     * Note that `<gio/gwin32outputstream.h>` belongs to the Windows-specific GIO
+     * interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file
+     * when using it.
+     * @gir-type Class
+     */
+    class OutputStream extends Gio.OutputStream {
+        static $gtype: GObject.GType<OutputStream>;
+
+        // Properties
+
+        /**
+         * Whether to close the file handle when the stream is closed.
+         * @since 2.26
+         */
+        get close_handle(): boolean;
+        set close_handle(val: boolean);
+        /**
+         * Whether to close the file handle when the stream is closed.
+         * @since 2.26
+         */
+        get closeHandle(): boolean;
+        set closeHandle(val: boolean);
+        /**
+         * The file handle that the stream writes to.
+         * @since 2.26
+         * @construct-only
+         */
+        get handle(): any;
+
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: OutputStream.SignalSignatures;
+
+        // Constructors
+
+        constructor(properties?: Partial<OutputStream.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](handle: any | null, close_handle: boolean): OutputStream;
+
+        // Signals
+
+        /** @signal */
+        connect<K extends keyof OutputStream.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, OutputStream.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        /** @signal */
+        connect_after<K extends keyof OutputStream.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, OutputStream.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        /** @signal */
+        emit<K extends keyof OutputStream.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<OutputStream.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
+        // Methods
+
+        /**
+         * Returns whether the handle of `stream` will be closed when the
+         * stream is closed.
+         * @returns `true` if the handle is closed when done
+         */
+        get_close_handle(): boolean;
+        /**
+         * Return the Windows handle that the stream writes to.
+         * @returns The handle descriptor of `stream`
+         */
+        get_handle(): any | null;
+        /**
+         * Sets whether the handle of `stream` shall be closed when the stream
+         * is closed.
+         * @param close_handle `true` to close the handle when done
+         */
+        set_close_handle(close_handle: boolean): void;
+    }
+
+    /**
+     * @gir-type Alias
+     */
+    type InputStreamClass = typeof InputStream;
+    /**
+     * @gir-type Struct
+     */
+    abstract class InputStreamPrivate {
+        static $gtype: GObject.GType<InputStreamPrivate>;
+    }
+
+    /**
+     * @gir-type Struct
+     */
+    class NetworkMonitor {
+        static $gtype: GObject.GType<NetworkMonitor>;
+    }
+
+    /**
+     * @gir-type Struct
+     */
+    class NetworkMonitorClass {
+        static $gtype: GObject.GType<NetworkMonitorClass>;
+
+        // Constructors
+
+        constructor(
+            properties?: Partial<{
+                parent_class: any;
+            }>,
+        );
+    }
+
+    /**
+     * @gir-type Struct
+     */
+    abstract class NetworkMonitorPrivate {
+        static $gtype: GObject.GType<NetworkMonitorPrivate>;
+    }
+
+    /**
+     * @gir-type Alias
+     */
+    type OutputStreamClass = typeof OutputStream;
+    /**
+     * @gir-type Struct
+     */
+    abstract class OutputStreamPrivate {
+        static $gtype: GObject.GType<OutputStreamPrivate>;
+    }
+
+    /**
+     * Name of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+     */
+    const __name__: string;
+    /**
+     * Version of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+     */
+    const __version__: string;
+}
+
+export default GioWin32;
+
+// END

package/giowin32-2.0.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import GioWin32 from 'gi://GioWin32?version=2.0';
+export default GioWin32;
+

package/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * This template is used to generate the index.d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import './giowin32-2.0-ambient.d.ts';
+
+import './giowin32-2.0-import.d.ts';
+
+import GioWin32 from './giowin32-2.0.js';
+export default GioWin32;

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import GioWin32 from './giowin32-2.0.js';
+export default GioWin32;
+

package/package.json

@@ -0,0 +1,55 @@
+{
+    "name": "@girs/giowin32-2.0",
+    "version": "2.0.0-4.0.0-rc.1",
+    "description": "GJS TypeScript type definitions for GioWin32-2.0, generated from library version 2.0.0",
+    "type": "module",
+    "module": "giowin32-2.0.js",
+    "main": "giowin32-2.0.js",
+    "exports": {
+      "./ambient": {
+        "types": "./giowin32-2.0-ambient.d.ts",
+        "import": "./giowin32-2.0-ambient.js",
+        "default": "./giowin32-2.0-ambient.js"
+      },
+      "./import": {
+        "types": "./giowin32-2.0-import.d.ts",
+        "import": "./giowin32-2.0-import.js",
+        "default": "./giowin32-2.0-import.js"
+      },
+      "./giowin32-2.0": {
+        "types": "./giowin32-2.0.d.ts",
+        "import": "./giowin32-2.0.js",
+        "default": "./giowin32-2.0.js"
+      },
+      ".": {
+        "types": "./index.d.ts",
+        "import": "./index.js",
+        "default": "./index.js"
+      }
+    },
+    "scripts": {
+      "test": "tsc --project tsconfig.json"
+    },
+    "dependencies": {
+      "@girs/gjs": "4.0.0-rc.1",
+      "@girs/gio-2.0": "2.88.0-4.0.0-rc.1",
+      "@girs/gobject-2.0": "2.88.0-4.0.0-rc.1",
+      "@girs/glib-2.0": "2.88.0-4.0.0-rc.1",
+      "@girs/gmodule-2.0": "2.0.0-4.0.0-rc.1"    },
+    "devDependencies": {
+      "typescript": "*"
+    },
+    "keywords": ["Gir", "TypeScript", "types", "GObject-Introspection", "GJS", "GioWin32-2.0"],
+    "author": "ts-for-gir",
+    "license": "MIT",
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/gjsify/types.git"
+    },
+    "bugs": {
+      "url": "https://github.com/gjsify/ts-for-gir/issues"
+    },
+    "homepage": "https://github.com/gjsify/types/tree/main/giowin32-2.0#readme"
+}
+
+

package/tsconfig.json

@@ -0,0 +1,42 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "NodeNext",
+    "lib": ["ESNext"],
+    "types": [],
+    "experimentalDecorators": true,
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF",
+    // Show diagnostics
+    "diagnostics": true,
+    "paths": {
+      "@girs/gio-2.0": [
+            "../gio-2.0/index.d.ts"
+      ],
+      "@girs/gobject-2.0": [
+            "../gobject-2.0/index.d.ts"
+      ],
+      "@girs/glib-2.0": [
+            "../glib-2.0/index.d.ts"
+      ],
+      "@girs/gmodule-2.0": [
+            "../gmodule-2.0/index.d.ts"
+      ],
+      "@girs/gjs": [
+            "../gjs/index.d.ts"
+      ]
+}
+  },
+  "include": ["./giowin32-2.0.d.ts"]
+}
+
+

package/typedoc.json

@@ -0,0 +1,9 @@
+{
+    "entryPoints": ["./giowin32-2.0.d.ts"],
+    "readme": "./README.md",
+    "name": "GioWin32-2.0",
+    "tsconfig": "./tsconfig.json",
+    "skipErrorChecking": true,
+    "highlightLanguages": ["typescript", "javascript", "c", "cpp", "xml", "bash", "json", "css"]
+}
+