@girs/mirage-3.2 3.2.9-4.0.0-beta.37

package/README.md

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

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import Mirage from './mirage-3.2.js';
+export default Mirage;
+

package/mirage-3.2-ambient.d.ts

@@ -0,0 +1,9 @@
+declare module 'gi://Mirage?version=3.2' {
+    import Mirage32 from '@girs/mirage-3.2';
+    export default Mirage32;
+}
+
+declare module 'gi://Mirage' {
+    import Mirage32 from 'gi://Mirage?version=3.2';
+    export default Mirage32;
+}

package/mirage-3.2-ambient.js

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

package/mirage-3.2-import.d.ts

@@ -0,0 +1,9 @@
+import type Mirage32 from '@girs/mirage-3.2';
+
+declare global {
+    export interface GjsGiImports {
+        Mirage: typeof Mirage32;
+    }
+}
+
+export default GjsGiImports;

package/mirage-3.2-import.js

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