@girs/ministream-1 0.99.0-4.0.0-beta.41

package/README.md

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

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import Ministream from './ministream-1.js';
+export default Ministream;
+

package/ministream-1-ambient.d.ts

@@ -0,0 +1,9 @@
+declare module 'gi://Ministream?version=1' {
+    import Ministream1 from '@girs/ministream-1';
+    export default Ministream1;
+}
+
+declare module 'gi://Ministream' {
+    import Ministream1 from 'gi://Ministream?version=1';
+    export default Ministream1;
+}

package/ministream-1-ambient.js

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

package/ministream-1-import.d.ts

@@ -0,0 +1,9 @@
+import type Ministream1 from '@girs/ministream-1';
+
+declare global {
+    export interface GjsGiImports {
+        Ministream: typeof Ministream1;
+    }
+}
+
+export default GjsGiImports;

package/ministream-1-import.js

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

package/ministream-1.d.ts

@@ -0,0 +1,166 @@
+/**
+ * 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 GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+
+export namespace Ministream {
+    /**
+     * Ministream-1
+     */
+
+    /**
+     * @gir-type Struct
+     */
+    class Error extends GLib.Error {
+        static $gtype: GObject.GType<GLib.Error>;
+
+        // Static fields
+
+        static NO_COMPONENT: number;
+        static NO_IDENTIFIER: number;
+
+        // Constructors
+
+        constructor(options: { message: string; code: number });
+
+        // Static methods
+
+        static quark(): GLib.Quark;
+    }
+
+    /**
+     * Ministream major version component.
+     */
+    const MAJOR_VERSION: number;
+    /**
+     * Ministream minor version component.
+     */
+    const MINOR_VERSION: number;
+    function error_quark(): GLib.Quark;
+    /**
+     * @gir-type Struct
+     */
+    class Component {
+        static $gtype: GObject.GType<Component>;
+
+        // Constructors
+
+        constructor(data: Uint8Array | string);
+
+        static new_from_xml_data(data: Uint8Array | string): Component;
+
+        // Methods
+
+        /**
+         * Get the bugtracker URI of this component.
+         * @returns the bugtracker URI
+         */
+        get_bugtracker_uri(): string | null;
+        /**
+         * Gets the desktop launchables this component provides.
+         * @returns the desktop launchables
+         */
+        get_desktop_launchables(): string[] | null;
+        /**
+         * Gets the name of the developer that has written this component in the
+         * best locale available.
+         * @returns the localized developer name
+         */
+        get_developer_name(): string | null;
+        /**
+         * Get the help URI of this component.
+         * @returns the help URI
+         */
+        get_help_uri(): string | null;
+        /**
+         * Get the homepage URI of this component.
+         * @returns the hompage URI
+         */
+        get_homepage_uri(): string | null;
+        /**
+         * Get the application identifier of this component. This should be in
+         * the big-endian domain format.
+         * @returns the application identifier
+         */
+        get_id(): string;
+        /**
+         * Get the application name of this component in the best locale
+         * available.
+         * @returns the localized application name
+         */
+        get_name(): string | null;
+        /**
+         * Get the license of the project this component is part of. This should
+         * be an identifier part of the SPDX license list.
+         * @returns the project license identifier
+         */
+        get_project_license(): string | null;
+        /**
+         * Gets the releases information of this component.
+         * @returns the releases of this component
+         */
+        get_releases(): Release[] | null;
+        /**
+         * Increment the reference count of the component.
+         *
+         * This is an atomic operation and as such, threadsafe.
+         * @returns the new reference of `self`
+         */
+        ref(): Component;
+        /**
+         * Decrements the reference count of the component. Once the count
+         * reaches zero, `self` will be freed.
+         *
+         * As such, do not use `self` after calling this method.
+         */
+        unref(): void;
+    }
+
+    /**
+     * @gir-type Struct
+     */
+    abstract class Release {
+        static $gtype: GObject.GType<Release>;
+
+        // Methods
+
+        /**
+         * Gets the description attached to the releease, or `null` if not set.
+         *
+         * The description is encoded as markup, containg paragraphs, ordered
+         * and unordered lists, aswell as list items within them.
+         * @returns the description of the release
+         */
+        get_description(): string | null;
+        /**
+         * Gets the version attached to the release, or `null` if not set.
+         * @returns the version of the release
+         */
+        get_version(): string | null;
+    }
+
+    /**
+     * 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 Ministream;
+
+// END

package/ministream-1.js

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

package/package.json

@@ -0,0 +1,53 @@
+{
+    "name": "@girs/ministream-1",
+    "version": "0.99.0-4.0.0-beta.41",
+    "description": "GJS TypeScript type definitions for Ministream-1, generated from library version 0.99.0",
+    "type": "module",
+    "module": "ministream-1.js",
+    "main": "ministream-1.js",
+    "exports": {
+      "./ambient": {
+        "types": "./ministream-1-ambient.d.ts",
+        "import": "./ministream-1-ambient.js",
+        "default": "./ministream-1-ambient.js"
+      },
+      "./import": {
+        "types": "./ministream-1-import.d.ts",
+        "import": "./ministream-1-import.js",
+        "default": "./ministream-1-import.js"
+      },
+      "./ministream-1": {
+        "types": "./ministream-1.d.ts",
+        "import": "./ministream-1.js",
+        "default": "./ministream-1.js"
+      },
+      ".": {
+        "types": "./index.d.ts",
+        "import": "./index.js",
+        "default": "./index.js"
+      }
+    },
+    "scripts": {
+      "test": "tsc --project tsconfig.json"
+    },
+    "dependencies": {
+      "@girs/gjs": "4.0.0-beta.41",
+      "@girs/gobject-2.0": "2.88.0-4.0.0-beta.41",
+      "@girs/glib-2.0": "2.88.0-4.0.0-beta.41"    },
+    "devDependencies": {
+      "typescript": "*"
+    },
+    "keywords": ["Gir", "TypeScript", "types", "GObject-Introspection", "GJS", "Ministream-1"],
+    "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/ministream-1#readme"
+}
+
+

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "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/gobject-2.0": [
+            "../gobject-2.0/index.d.ts"
+      ],
+      "@girs/glib-2.0": [
+            "../glib-2.0/index.d.ts"
+      ],
+      "@girs/gjs": [
+            "../gjs/index.d.ts"
+      ]
+}
+  },
+  "include": ["./ministream-1.d.ts"]
+}
+
+

package/typedoc.json

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