@girs/cmbcatalogutils-3.0 3.0.0-4.0.0-beta.37

package/README.md

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

@@ -0,0 +1,9 @@
+declare module 'gi://CmbCatalogUtils?version=3.0' {
+    import CmbCatalogUtils30 from '@girs/cmbcatalogutils-3.0';
+    export default CmbCatalogUtils30;
+}
+
+declare module 'gi://CmbCatalogUtils' {
+    import CmbCatalogUtils30 from 'gi://CmbCatalogUtils?version=3.0';
+    export default CmbCatalogUtils30;
+}

package/cmbcatalogutils-3.0-ambient.js

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

package/cmbcatalogutils-3.0-import.d.ts

@@ -0,0 +1 @@
+// 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: "CmbCatalogUtils"

package/cmbcatalogutils-3.0-import.js

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

package/cmbcatalogutils-3.0.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 Gtk from '@girs/gtk-3.0';
+import type xlib from '@girs/xlib-2.0';
+import type Gdk from '@girs/gdk-3.0';
+import type cairo from 'cairo';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+import type Pango from '@girs/pango-1.0';
+import type HarfBuzz from '@girs/harfbuzz-0.0';
+import type freetype2 from '@girs/freetype2-2.0';
+import type Gio from '@girs/gio-2.0';
+import type GModule from '@girs/gmodule-2.0';
+import type GdkPixbuf from '@girs/gdkpixbuf-2.0';
+import type Atk from '@girs/atk-1.0';
+
+export namespace CmbCatalogUtils {
+    /**
+     * CmbCatalogUtils-3.0
+     */
+
+    function a11y_action_get_name(accessible: Atk.Object): string;
+    /**
+     * Return internal child
+     * @param buildable Object to check
+     * @param childname internal child
+     * @returns the internal child of the buildable object
+     */
+    function buildable_get_internal_child<T = GObject.Object>(buildable: Gtk.Buildable, childname: string): T;
+    /**
+     * Return the list of properties declared in `name`
+     * @param name Class name
+     * @returns class properties
+     */
+    function get_class_properties(name: string): GObject.ParamSpec[];
+    /**
+     * Return the list of properties declared in `name` iface
+     * @param name Interface type name
+     * @returns iface properties
+     */
+    function get_iface_properties(name: string): GObject.ParamSpec[];
+    /**
+     * Return whether buildable implements add_child() or not
+     * @param buildable Object to check
+     */
+    function implements_buildable_add_child(buildable: GObject.Object): boolean;
+    function pspec_enum_get_default_nick(gtype: GObject.GType, default_value: number): string;
+    function pspec_flags_get_default_nick(gtype: GObject.GType, default_value: number): string;
+    /**
+     * 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 CmbCatalogUtils;
+
+// END

package/cmbcatalogutils-3.0.js

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

package/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 './cmbcatalogutils-3.0-ambient.d.ts';
+
+import CmbCatalogUtils from './cmbcatalogutils-3.0.js';
+export default CmbCatalogUtils;

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import CmbCatalogUtils from './cmbcatalogutils-3.0.js';
+export default CmbCatalogUtils;
+

package/package.json

@@ -0,0 +1,64 @@
+{
+    "name": "@girs/cmbcatalogutils-3.0",
+    "version": "3.0.0-4.0.0-beta.37",
+    "description": "GJS TypeScript type definitions for CmbCatalogUtils-3.0, generated from library version 3.0.0",
+    "type": "module",
+    "module": "cmbcatalogutils-3.0.js",
+    "main": "cmbcatalogutils-3.0.js",
+    "exports": {
+      "./ambient": {
+        "types": "./cmbcatalogutils-3.0-ambient.d.ts",
+        "import": "./cmbcatalogutils-3.0-ambient.js",
+        "default": "./cmbcatalogutils-3.0-ambient.js"
+      },
+      "./import": {
+        "types": "./cmbcatalogutils-3.0-import.d.ts",
+        "import": "./cmbcatalogutils-3.0-import.js",
+        "default": "./cmbcatalogutils-3.0-import.js"
+      },
+      "./cmbcatalogutils-3.0": {
+        "types": "./cmbcatalogutils-3.0.d.ts",
+        "import": "./cmbcatalogutils-3.0.js",
+        "default": "./cmbcatalogutils-3.0.js"
+      },
+      ".": {
+        "types": "./index.d.ts",
+        "import": "./index.js",
+        "default": "./index.js"
+      }
+    },
+    "scripts": {
+      "test": "tsc --project tsconfig.json"
+    },
+    "dependencies": {
+      "@girs/gjs": "4.0.0-beta.37",
+      "@girs/gtk-3.0": "3.24.49-4.0.0-beta.37",
+      "@girs/xlib-2.0": "2.0.0-4.0.0-beta.37",
+      "@girs/gdk-3.0": "3.24.49-4.0.0-beta.37",
+      "@girs/cairo-1.0": "1.0.0-4.0.0-beta.37",
+      "@girs/gobject-2.0": "2.86.0-4.0.0-beta.37",
+      "@girs/glib-2.0": "2.86.0-4.0.0-beta.37",
+      "@girs/pango-1.0": "1.57.0-4.0.0-beta.37",
+      "@girs/harfbuzz-0.0": "11.5.0-4.0.0-beta.37",
+      "@girs/freetype2-2.0": "2.0.0-4.0.0-beta.37",
+      "@girs/gio-2.0": "2.86.0-4.0.0-beta.37",
+      "@girs/gmodule-2.0": "2.0.0-4.0.0-beta.37",
+      "@girs/gdkpixbuf-2.0": "2.0.0-4.0.0-beta.37",
+      "@girs/atk-1.0": "2.58.0-4.0.0-beta.37"    },
+    "devDependencies": {
+      "typescript": "*"
+    },
+    "keywords": ["Gir", "TypeScript", "types", "GObject-Introspection", "GJS", "CmbCatalogUtils-3.0"],
+    "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/cmbcatalogutils-3.0#readme"
+}
+
+

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "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
+  },
+  "include": ["./cmbcatalogutils-3.0.d.ts"]
+}
+
+

package/typedoc.json

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