@girs/gvncpulse-1.0 1.0.0-3.0.0-beta.12

package/README.md

@@ -0,0 +1,33 @@
+
+# GVncPulse-1.0
+
+GJS TypeScript type definitions for GVncPulse-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gjs) v3.0.0-beta.12.
+
+A bridge to the Pulse Audio system for VNC. It allows VNC clients to play back audio on the local system
+
+## Install
+
+To use this type definitions, install them with NPM like this:
+```bash
+npm install @girs/gvncpulse-1.0
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import GVncPulse from '@girs/gvncpulse-1.0';
+```
+
+Or if you prefer CommonJS, you can also use this:
+```ts
+const GVncPulse = require('@girs/gvncpulse-1.0');
+```
+
+If you use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules), you can also import this module like you would do this in JavaScript:
+
+```ts
+import GVncPulse from 'gi://GVncPulse?version=1.0';
+```
+
+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).

package/gvncpulse-1.0.cjs

@@ -0,0 +1,9 @@
+
+
+  imports.gi.versions.GVncPulse = '1.0'
+  const GVncPulse = imports.gi.GVncPulse;
+  
+    module.exports = GVncPulse;
+  
+
+

package/gvncpulse-1.0.d.cts

@@ -0,0 +1,113 @@
+
+/*
+ * 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-gjs
+ */
+/**
+ * GVncPulse-1.0
+ */
+
+import type GVnc from '@girs/gvnc-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 module AudioPulse {
+
+    // Constructor properties interface
+
+    export interface ConstructorProperties extends GVnc.Audio.ConstructorProperties, GVnc.BaseAudio.ConstructorProperties {
+    }
+
+}
+
+export interface AudioPulse extends GVnc.Audio {
+
+    // Own fields of GVncPulse-1.0.GVncPulse.AudioPulse
+
+    parent: GVnc.BaseAudio & GObject.Object
+    priv: any
+
+    // Class property signals of GVncPulse-1.0.GVncPulse.AudioPulse
+
+    connect(sigName: string, callback: (...args: any[]) => void): number
+    connect_after(sigName: string, callback: (...args: any[]) => void): number
+    emit(sigName: string, ...args: any[]): void
+    disconnect(id: number): void
+}
+
+export class AudioPulse extends GVnc.BaseAudio {
+
+    // Own properties of GVncPulse-1.0.GVncPulse.AudioPulse
+
+    static name: string
+    static $gtype: GObject.GType<AudioPulse>
+
+    // Constructors of GVncPulse-1.0.GVncPulse.AudioPulse
+
+    constructor(config?: AudioPulse.ConstructorProperties) 
+    /**
+     * Create a new VNC audio object able to play
+     * audio samples via pulseaudio
+     * @constructor 
+     * @returns the new audio object
+     */
+    constructor() 
+    /**
+     * Create a new VNC audio object able to play
+     * audio samples via pulseaudio
+     * @constructor 
+     * @returns the new audio object
+     */
+    static new(): AudioPulse
+
+    // Overloads of new
+
+    /**
+     * Create a new generic VNC audio object, which will emit
+     * signals when key audio events occur. Callers can connect
+     * to these signals to provide playback facilities.
+     * @constructor 
+     * @returns a new audio object
+     */
+    static new(): GVnc.BaseAudio
+    _init(config?: AudioPulse.ConstructorProperties): void
+}
+
+export interface AudioPulseClass {
+
+    // Own fields of GVncPulse-1.0.GVncPulse.AudioPulseClass
+
+    parent_class: GVnc.BaseAudioClass
+}
+
+export abstract class AudioPulseClass {
+
+    // Own properties of GVncPulse-1.0.GVncPulse.AudioPulseClass
+
+    static name: string
+}
+
+export interface AudioPulsePrivate {
+}
+
+export class AudioPulsePrivate {
+
+    // Own properties of GVncPulse-1.0.GVncPulse.AudioPulsePrivate
+
+    static name: string
+}
+
+/**
+ * Name of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+ */
+export const __name__: string
+/**
+ * Version of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+ */
+export const __version__: string
+// END

package/gvncpulse-1.0.d.ts

@@ -0,0 +1,118 @@
+
+/*
+ * 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-gjs
+ */
+/**
+ * GVncPulse-1.0
+ */
+
+import type GVnc from '@girs/gvnc-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 GVncPulse {
+
+module AudioPulse {
+
+    // Constructor properties interface
+
+    interface ConstructorProperties extends GVnc.Audio.ConstructorProperties, GVnc.BaseAudio.ConstructorProperties {
+    }
+
+}
+
+interface AudioPulse extends GVnc.Audio {
+
+    // Own fields of GVncPulse-1.0.GVncPulse.AudioPulse
+
+    parent: GVnc.BaseAudio & GObject.Object
+    priv: any
+
+    // Class property signals of GVncPulse-1.0.GVncPulse.AudioPulse
+
+    connect(sigName: string, callback: (...args: any[]) => void): number
+    connect_after(sigName: string, callback: (...args: any[]) => void): number
+    emit(sigName: string, ...args: any[]): void
+    disconnect(id: number): void
+}
+
+class AudioPulse extends GVnc.BaseAudio {
+
+    // Own properties of GVncPulse-1.0.GVncPulse.AudioPulse
+
+    static name: string
+    static $gtype: GObject.GType<AudioPulse>
+
+    // Constructors of GVncPulse-1.0.GVncPulse.AudioPulse
+
+    constructor(config?: AudioPulse.ConstructorProperties) 
+    /**
+     * Create a new VNC audio object able to play
+     * audio samples via pulseaudio
+     * @constructor 
+     * @returns the new audio object
+     */
+    constructor() 
+    /**
+     * Create a new VNC audio object able to play
+     * audio samples via pulseaudio
+     * @constructor 
+     * @returns the new audio object
+     */
+    static new(): AudioPulse
+
+    // Overloads of new
+
+    /**
+     * Create a new generic VNC audio object, which will emit
+     * signals when key audio events occur. Callers can connect
+     * to these signals to provide playback facilities.
+     * @constructor 
+     * @returns a new audio object
+     */
+    static new(): GVnc.BaseAudio
+    _init(config?: AudioPulse.ConstructorProperties): void
+}
+
+interface AudioPulseClass {
+
+    // Own fields of GVncPulse-1.0.GVncPulse.AudioPulseClass
+
+    parent_class: GVnc.BaseAudioClass
+}
+
+abstract class AudioPulseClass {
+
+    // Own properties of GVncPulse-1.0.GVncPulse.AudioPulseClass
+
+    static name: string
+}
+
+interface AudioPulsePrivate {
+}
+
+class AudioPulsePrivate {
+
+    // Own properties of GVncPulse-1.0.GVncPulse.AudioPulsePrivate
+
+    static name: 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 GVncPulse;
+// END

package/gvncpulse-1.0.js

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

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@girs/gvncpulse-1.0",
+  "version": "1.0.0-3.0.0-beta.12",
+  "description": "GJS TypeScript type definitions for GVncPulse-1.0, generated from library version 1.0.0",
+  "type": "module",
+  "module": "gvncpulse-1.0.js",
+  "main": "gvncpulse-1.0.js",
+  "typedoc": {
+    "entryPoint": "./gvncpulse-1.0.d.ts",
+    "readmeFile": "./README.md",
+    "displayName": "GVncPulse-1.0",
+    "tsconfig": "./tsconfig.doc.json"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./gvncpulse-1.0.d.ts",
+        "default": "./gvncpulse-1.0.js"
+      },
+      "require": {
+        "types": "./gvncpulse-1.0.d.cts",
+        "default": "./gvncpulse-1.0.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "test": "yarn test:esm && yarn test:cjs",
+    "test:esm": "tsc --noEmit gvncpulse-1.0.d.ts",
+    "test:cjs": "tsc --noEmit gvncpulse-1.0.d.cts"
+  },
+  "dependencies": {
+    "@girs/gio-2.0": "^2.75.1-3.0.0-beta.12",
+    "@girs/glib-2.0": "^2.75.1-3.0.0-beta.12",
+    "@girs/gobject-2.0": "^2.75.1-3.0.0-beta.12",
+    "@girs/gvnc-1.0": "^1.3.1-3.0.0-beta.12"
+  },
+  "devDependencies": {
+    "typescript": "^*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "GVncPulse-1.0"
+  ],
+  "author": "ts-for-gir",
+  "license": "Apache-2.0",
+  "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/ts-for-gir#readme"
+}

package/tsconfig.doc.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "ESNext",
+    "experimentalDecorators": true,
+    "moduleResolution": "node",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF"
+  },
+  "include": ["./gvncpulse-1.0.d.ts"]
+}