@girs/translit-1.0 1.0.0-4.0.0-beta.3

package/README.md

@@ -0,0 +1,86 @@
+
+# Translit-1.0
+
+![version](https://img.shields.io/npm/v/@girs/translit-1.0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/translit-1.0)
+
+
+GJS TypeScript type definitions for Translit-1.0, generated from library version 1.0.0 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/translit-1.0
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import Translit from '@girs/translit-1.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/translit-1.0` or `@girs/translit-1.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/translit-1.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/translit-1.0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import Translit from 'gi://Translit?version=1.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/translit-1.0` or `@girs/translit-1.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/translit-1.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/translit-1.0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const Translit = imports.gi.Translit;
+```
+
+### 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/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@girs/translit-1.0",
+  "version": "1.0.0-4.0.0-beta.3",
+  "description": "GJS TypeScript type definitions for Translit-1.0, generated from library version 1.0.0",
+  "type": "module",
+  "module": "translit-1.0.js",
+  "main": "translit-1.0.js",
+  "exports": {
+    "./ambient": {
+      "types": "./translit-1.0-ambient.d.ts",
+      "import": "./translit-1.0-ambient.js",
+      "default": "./translit-1.0-ambient.js"
+    },
+    "./import": {
+      "types": "./translit-1.0-import.d.ts",
+      "import": "./translit-1.0-import.js",
+      "default": "./translit-1.0-import.js"
+    },
+    ".": {
+      "types": "./translit-1.0.d.ts",
+      "import": "./translit-1.0.js",
+      "default": "./translit-1.0.js"
+    }
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit translit-1.0.d.ts"
+  },
+  "dependencies": {
+    "@girs/gio-2.0": "^2.80.0-4.0.0-beta.3",
+    "@girs/gjs": "^4.0.0-beta.3",
+    "@girs/glib-2.0": "^2.80.0-4.0.0-beta.3",
+    "@girs/gobject-2.0": "^2.80.0-4.0.0-beta.3"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "Translit-1.0"
+  ],
+  "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/translit-1.0#readme"
+}

package/translit-1.0-ambient.d.ts

@@ -0,0 +1,12 @@
+
+declare module 'gi://Translit?version=1.0' {
+    import Translit from '@girs/translit-1.0';
+    export default Translit;
+}
+
+declare module 'gi://Translit' {
+    import Translit10 from 'gi://Translit?version=1.0';
+    export default Translit10;
+}
+
+

package/translit-1.0-ambient.js

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

package/translit-1.0-import.d.ts

@@ -0,0 +1,12 @@
+
+import Translit10 from '@girs/translit-1.0';
+
+declare global {
+    export interface GjsGiImports {
+        Translit: typeof Translit10;
+    }
+}
+
+export default GjsGiImports;
+
+

package/translit-1.0-import.js

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

package/translit-1.0.d.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 './translit-1.0-ambient.d.ts';
+
+/**
+ * Translit-1.0
+ */
+
+import type Gio from '@girs/gio-2.0';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+
+export namespace Translit {
+    enum ErrorEnum {
+        NO_SUCH_BACKEND,
+        LOAD_FAILED,
+        INVALID_INPUT,
+        FAILED,
+    }
+    function error_quark(): GLib.Quark;
+    function implement_transliterator(backend: string, type: GObject.GType): void;
+    module Transliterator {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            name: string;
+        }
+    }
+
+    class Transliterator extends GObject.Object {
+        static $gtype: GObject.GType<Transliterator>;
+
+        // Own properties of Translit.Transliterator
+
+        /**
+         * The transliteration which #TranslitTransliterator supports
+         */
+        get name(): string;
+
+        // Constructors of Translit.Transliterator
+
+        constructor(properties?: Partial<Transliterator.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Own static methods of Translit.Transliterator
+
+        /**
+         * Get a transliterator instance whose name is `name`.
+         * @param backend backend name (e.g. "m17n")
+         * @param name name of the transliterator (e.g. "hi-inscript")
+         */
+        static get(backend: string, name: string): Transliterator;
+
+        // Own virtual methods of Translit.Transliterator
+
+        vfunc_transliterate(input: string): [string, number];
+
+        // Own methods of Translit.Transliterator
+
+        transliterate(input: string): [string, number];
+    }
+
+    type TransliteratorClass = typeof Transliterator;
+    abstract class TransliteratorPrivate {
+        static $gtype: GObject.GType<TransliteratorPrivate>;
+
+        // Constructors of Translit.TransliteratorPrivate
+
+        _init(...args: any[]): void;
+    }
+
+    /**
+     * 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 Translit;
+// END

package/translit-1.0.js

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

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": ["./translit-1.0.d.ts"]
+}
+
+

package/typedoc.json

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