@girs/govf-0.1 0.1.0-4.0.0-beta.6

package/README.md

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

@@ -0,0 +1,12 @@
+
+declare module 'gi://Govf?version=0.1' {
+    import Govf from '@girs/govf-0.1';
+    export default Govf;
+}
+
+declare module 'gi://Govf' {
+    import Govf01 from 'gi://Govf?version=0.1';
+    export default Govf01;
+}
+
+

package/govf-0.1-ambient.js

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

package/govf-0.1-import.d.ts

@@ -0,0 +1,12 @@
+
+import Govf01 from '@girs/govf-0.1';
+
+declare global {
+    export interface GjsGiImports {
+        Govf: typeof Govf01;
+    }
+}
+
+export default GjsGiImports;
+
+

package/govf-0.1-import.js

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

package/govf-0.1.d.ts

@@ -0,0 +1,180 @@
+/*
+ * 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
+ */
+
+import './govf-0.1-ambient.d.ts';
+
+/**
+ * Govf-0.1
+ */
+
+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 Govf {
+    enum PackageError {
+        FAILED,
+        NOT_FOUND,
+        XML,
+        LAST,
+    }
+    module Disk {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {}
+    }
+
+    class Disk extends GObject.Object {
+        static $gtype: GObject.GType<Disk>;
+
+        // Constructors of Govf.Disk
+
+        constructor(properties?: Partial<Disk.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](): Disk;
+
+        // Own methods of Govf.Disk
+
+        /**
+         * Returns the disk's capacity.
+         * @returns the capacity
+         */
+        get_capacity(): string;
+        /**
+         * Returns the disk id.
+         * @returns the disk id
+         */
+        get_disk_id(): string;
+        /**
+         * Returns the disk's file reference.
+         * @returns the file ref
+         */
+        get_file_ref(): string;
+        /**
+         * Returns the disk's format.
+         * @returns the format
+         */
+        get_format(): string;
+        /**
+         * Sets a new capacity for the disk.
+         * @param capacity capacity for the disk
+         */
+        set_capacity(capacity: string): void;
+        /**
+         * Sets a new disk id for the disk.
+         * @param disk_id disk id for the disk
+         */
+        set_disk_id(disk_id: string): void;
+        /**
+         * Sets a new file reference for the disk.
+         * @param file_ref file ref for the disk
+         */
+        set_file_ref(file_ref: string): void;
+        /**
+         * Sets a new format for the disk.
+         * @param format format for the disk
+         */
+        set_format(format: string): void;
+    }
+
+    module Package {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {}
+    }
+
+    class Package extends GObject.Object {
+        static $gtype: GObject.GType<Package>;
+
+        // Constructors of Govf.Package
+
+        constructor(properties?: Partial<Package.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](): Package;
+
+        // Own static methods of Govf.Package
+
+        static error_quark(): GLib.Quark;
+
+        // Own methods of Govf.Package
+
+        /**
+         * Extracts a disk...
+         * @param disk a #GovfDisk
+         * @param save_path a file path
+         * @param cancellable a #GCancellable or %NULL
+         * @param callback a #GAsyncReadyCallback to call      when the request is satisfied
+         */
+        extract_disk(
+            disk: Disk,
+            save_path: string,
+            cancellable?: Gio.Cancellable | null,
+            callback?: Gio.AsyncReadyCallback<this> | null,
+        ): void;
+        extract_disk_finish(result: Gio.AsyncResult): boolean;
+        /**
+         * Returns an array with all the disks associated with the OVF package.
+         * @returns an array
+         */
+        get_disks(): Disk[];
+        /**
+         * Loads an OVF package from a memory buffer that holds an .ovf file.
+         * @param data OVF data
+         * @param length size of the OVF data
+         * @returns %TRUE if the operation succeeded
+         */
+        load_from_data(data: string, length: number): boolean;
+        /**
+         * Loads an OVF package from an uncompressed .ovf file.
+         * @param filename an .ovf file name
+         * @returns %TRUE if the operation succeeded
+         */
+        load_from_file(filename: string): boolean;
+        /**
+         * Loads an OVF package from a compressed .ova file.
+         *
+         * `callback` should call govf_package_load_from_ova_file_finish()
+         * to get the result of this asynchronous operation.
+         * @param filename an .ova file name
+         * @param cancellable a #GCancellable or %NULL
+         * @param callback a #GAsyncReadyCallback to call when      the request is satisfied
+         */
+        load_from_ova_file(
+            filename: string,
+            cancellable?: Gio.Cancellable | null,
+            callback?: Gio.AsyncReadyCallback<this> | null,
+        ): void;
+        load_from_ova_file_finish(result: Gio.AsyncResult): boolean;
+        /**
+         * Saves the OVF package to an uncompressed .ovf file.
+         * @param filename an .ovf file name
+         * @returns %TRUE if the operation succeeded
+         */
+        save_file(filename: string): boolean;
+    }
+
+    type DiskClass = typeof Disk;
+    type PackageClass = typeof Package;
+    /**
+     * 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 Govf;
+// END

package/govf-0.1.js

@@ -0,0 +1,6 @@
+
+  // @ts-expect-error
+  import Govf from 'gi://Govf?version=0.1';
+  export { Govf };
+  export default Govf;
+

package/package.json

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

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "ESNext",
+    "lib": ["ESNext"],
+    "types": [],
+    "experimentalDecorators": true,
+    "moduleResolution": "node",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF"
+  },
+  "include": ["./govf-0.1.d.ts"]
+}
+
+

package/typedoc.json

@@ -0,0 +1,7 @@
+{
+    "entryPoints": ["./govf-0.1.d.ts"],
+    "readme": "./README.md",
+    "name": "Govf-0.1",
+    "tsconfig": "./tsconfig.json"
+}
+