@girs/gmime-2.6 2.6.23-4.0.0-beta.3

package/README.md

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

@@ -0,0 +1,8 @@
+
+declare module 'gi://GMime?version=2.6' {
+    import GMime from '@girs/gmime-2.6';
+    export default GMime;
+}
+
+
+

package/gmime-2.6-ambient.js

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

package/gmime-2.6-import.d.ts

@@ -0,0 +1,2 @@
+// Module import type definition not generated, otherwise this would cause a type conflict, this is because several GIR modules were generated with the same namespace: "GMime"
+

package/gmime-2.6-import.js

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