@girs/keybinder-3.0 3.0.0-4.0.0-beta.3

package/README.md

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

@@ -0,0 +1,12 @@
+
+declare module 'gi://Keybinder?version=3.0' {
+    import Keybinder from '@girs/keybinder-3.0';
+    export default Keybinder;
+}
+
+declare module 'gi://Keybinder' {
+    import Keybinder30 from 'gi://Keybinder?version=3.0';
+    export default Keybinder30;
+}
+
+

package/keybinder-3.0-ambient.js

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

package/keybinder-3.0-import.d.ts

@@ -0,0 +1,12 @@
+
+import Keybinder30 from '@girs/keybinder-3.0';
+
+declare global {
+    export interface GjsGiImports {
+        Keybinder: typeof Keybinder30;
+    }
+}
+
+export default GjsGiImports;
+
+

package/keybinder-3.0-import.js

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

package/keybinder-3.0.d.ts

@@ -0,0 +1,76 @@
+/*
+ * 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 './keybinder-3.0-ambient.d.ts';
+
+/**
+ * Keybinder-3.0
+ */
+
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+
+export namespace Keybinder {
+    /**
+     * Grab a key combination globally and register a callback to be called each
+     * time the key combination is pressed.
+     * @param keystring an accelerator description (gtk_accelerator_parse() format)
+     * @param handler callback function
+     * @param notify called when @handler is unregistered
+     * @returns %TRUE if the accelerator could be grabbed
+     */
+    function bind(keystring: string, handler: Handler, notify?: GLib.DestroyNotify | null): boolean;
+    function get_current_event_time(): number;
+    /**
+     * Initialize the keybinder library.
+     *
+     * This function must be called after initializing GTK, before calling any
+     * other function in the library. Can only be called once.
+     */
+    function init(): void;
+    /**
+     * "Cooked" accelerators use symbols produced by using modifiers such
+     * as shift or altgr, for example if "!" is produced by "Shift+1".
+     *
+     * If cooked accelerators are enabled, use "<Ctrl>exclam" to bind
+     * "Ctrl+!" If disabled, use "<Ctrl><Shift>1" to bind
+     * "Ctrl+Shift+1". These two examples are not equal on all keymaps.
+     *
+     * The cooked accelerator keyvalue and modifiers are provided by the
+     * function gdk_keymap_translate_keyboard_state()
+     *
+     * Cooked accelerators are useful if you receive keystrokes from GTK to bind,
+     * but raw accelerators can be useful if you or the user inputs accelerators as
+     * text.
+     *
+     * Default: Enabled. Should be set before binding anything.
+     * @param use_cooked if %FALSE disable cooked accelerators
+     */
+    function set_use_cooked_accelerators(use_cooked: boolean): void;
+    function supported(): boolean;
+    /**
+     * Unregister all previously bound callbacks for this keystring.
+     * @param keystring an accelerator description (gtk_accelerator_parse() format)
+     */
+    function unbind(keystring: string): void;
+    interface Handler {
+        (keystring: string): 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 Keybinder;
+// END

package/keybinder-3.0.js

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

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@girs/keybinder-3.0",
+  "version": "3.0.0-4.0.0-beta.3",
+  "description": "GJS TypeScript type definitions for Keybinder-3.0, generated from library version 3.0.0",
+  "type": "module",
+  "module": "keybinder-3.0.js",
+  "main": "keybinder-3.0.js",
+  "exports": {
+    "./ambient": {
+      "types": "./keybinder-3.0-ambient.d.ts",
+      "import": "./keybinder-3.0-ambient.js",
+      "default": "./keybinder-3.0-ambient.js"
+    },
+    "./import": {
+      "types": "./keybinder-3.0-import.d.ts",
+      "import": "./keybinder-3.0-import.js",
+      "default": "./keybinder-3.0-import.js"
+    },
+    ".": {
+      "types": "./keybinder-3.0.d.ts",
+      "import": "./keybinder-3.0.js",
+      "default": "./keybinder-3.0.js"
+    }
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit keybinder-3.0.d.ts"
+  },
+  "dependencies": {
+    "@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",
+    "Keybinder-3.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/keybinder-3.0#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": ["./keybinder-3.0.d.ts"]
+}
+
+

package/typedoc.json

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