@girs/glibunix-2.0 2.0.0-3.3.0

package/README.md

@@ -0,0 +1,104 @@
+
+# GLibUnix-2.0
+
+![version](https://img.shields.io/npm/v/@girs/glibunix-2.0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/glibunix-2.0)
+
+
+GJS TypeScript type definitions for GLibUnix-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.3.0.
+
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/glibunix-2.0
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import GLibUnix from '@girs/glibunix-2.0';
+```
+
+Or if you prefer CommonJS, you can also use this:
+```ts
+const GLibUnix = require('@girs/glibunix-2.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/glibunix-2.0` or `@girs/glibunix-2.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/glibunix-2.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/glibunix-2.0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import GLibUnix from 'gi://GLibUnix?version=2.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/glibunix-2.0` or `@girs/glibunix-2.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/glibunix-2.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/glibunix-2.0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const GLibUnix = imports.gi.GLibUnix;
+```
+
+
+### ESM vs. CommonJS
+
+GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
+
+In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use `ESM` syntax and then decide the import syntax for your bundled file. If your bundler is configured to use `CommonJS`, it will convert to the GJS-specific global imports syntax, like `const moduleName = imports.gi[moduleName]`. This is different from the traditional `require` syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.
+
+On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.
+
+This approach is particularly important due to the `@girs` types, which include both `*.cjs `files, using the GJS global imports syntax, and `*.js` files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.
+
+Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.
+
+### 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/glibunix-2.0-ambient.d.ts

@@ -0,0 +1,12 @@
+
+declare module 'gi://GLibUnix?version=2.0' {
+    import GLibUnix20 from '@girs/glibunix-2.0';
+    export default GLibUnix20;
+}
+
+declare module 'gi://GLibUnix' {
+    import GLibUnix20 from '@girs/glibunix-2.0';
+    export default GLibUnix20;
+}
+
+

package/glibunix-2.0-ambient.js

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

package/glibunix-2.0-import.d.ts

@@ -0,0 +1,12 @@
+
+import GLibUnix20 from '@girs/glibunix-2.0';
+
+declare global {
+    export interface GjsGiImports {
+        GLibUnix: typeof GLibUnix20;
+    }
+}
+
+export default GjsGiImports;
+
+

package/glibunix-2.0-import.js

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

package/glibunix-2.0.cjs

@@ -0,0 +1,11 @@
+
+
+  imports.gi.versions.GLibUnix = '2.0'
+  const GLibUnix = imports.gi.GLibUnix;
+  
+    module.exports = GLibUnix;
+  
+
+
+
+

package/glibunix-2.0.d.cts

@@ -0,0 +1,88 @@
+
+/*
+ * 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 './glibunix-2.0-ambient.d.ts';
+import './glibunix-2.0-import.d.ts';
+/**
+ * GLibUnix-2.0
+ */
+
+import type GLib from '@girs/glib-2.0';
+import type GObject from '@girs/gobject-2.0';
+
+/**
+ * Mnemonic constants for the ends of a Unix pipe.
+ */
+export enum PipeEnd {
+    /**
+     * The readable file descriptor 0
+     */
+    READ,
+    /**
+     * The writable file descriptor 1
+     */
+    WRITE,
+}
+export function closefrom(lowfd: number): number
+export function error_quark(): GLib.Quark
+export function fd_add_full(priority: number, fd: number, condition: GLib.IOCondition, function_: GLib.UnixFDSourceFunc): number
+export function fd_source_new(fd: number, condition: GLib.IOCondition): GLib.Source
+export function fdwalk_set_cloexec(lowfd: number): number
+export function get_passwd_entry(user_name: string): any | null
+export function open_pipe(fds: number, flags: number): boolean
+export function set_fd_nonblocking(fd: number, nonblock: boolean): boolean
+export function signal_add_full(priority: number, signum: number, handler: GLib.SourceFunc): number
+export function signal_source_new(signum: number): GLib.Source
+/**
+ * The type of functions to be called when a UNIX fd watch source
+ * triggers.
+ * @callback 
+ * @param fd the fd that triggered the event
+ * @param condition the IO conditions reported on `fd`
+ * @returns %FALSE if the source should be removed
+ */
+export interface FDSourceFunc {
+    (fd: number, condition: GLib.IOCondition): boolean
+}
+export interface Pipe {
+
+    // Own fields of GLibUnix-2.0.GLibUnix.Pipe
+
+    /**
+     * A pair of file descriptors, each negative if closed or not yet opened.
+     *  The file descriptor with index %G_UNIX_PIPE_END_READ is readable.
+     *  The file descriptor with index %G_UNIX_PIPE_END_WRITE is writable.
+     * @field 
+     */
+    fds: number[]
+}
+
+/**
+ * A Unix pipe. The advantage of this type over `int[2]` is that it can
+ * be closed automatically when it goes out of scope, using `g_auto(GUnixPipe)`,
+ * on compilers that support that feature.
+ * @record 
+ */
+export class Pipe {
+
+    // Own properties of GLibUnix-2.0.GLibUnix.Pipe
+
+    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/glibunix-2.0.d.ts

@@ -0,0 +1,93 @@
+
+/*
+ * 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 './glibunix-2.0-ambient.d.ts';
+import './glibunix-2.0-import.d.ts';
+/**
+ * GLibUnix-2.0
+ */
+
+import type GLib from '@girs/glib-2.0';
+import type GObject from '@girs/gobject-2.0';
+
+export namespace GLibUnix {
+
+/**
+ * Mnemonic constants for the ends of a Unix pipe.
+ */
+enum PipeEnd {
+    /**
+     * The readable file descriptor 0
+     */
+    READ,
+    /**
+     * The writable file descriptor 1
+     */
+    WRITE,
+}
+function closefrom(lowfd: number): number
+function error_quark(): GLib.Quark
+function fd_add_full(priority: number, fd: number, condition: GLib.IOCondition, function_: GLib.UnixFDSourceFunc): number
+function fd_source_new(fd: number, condition: GLib.IOCondition): GLib.Source
+function fdwalk_set_cloexec(lowfd: number): number
+function get_passwd_entry(user_name: string): any | null
+function open_pipe(fds: number, flags: number): boolean
+function set_fd_nonblocking(fd: number, nonblock: boolean): boolean
+function signal_add_full(priority: number, signum: number, handler: GLib.SourceFunc): number
+function signal_source_new(signum: number): GLib.Source
+/**
+ * The type of functions to be called when a UNIX fd watch source
+ * triggers.
+ * @callback 
+ * @param fd the fd that triggered the event
+ * @param condition the IO conditions reported on `fd`
+ * @returns %FALSE if the source should be removed
+ */
+interface FDSourceFunc {
+    (fd: number, condition: GLib.IOCondition): boolean
+}
+interface Pipe {
+
+    // Own fields of GLibUnix-2.0.GLibUnix.Pipe
+
+    /**
+     * A pair of file descriptors, each negative if closed or not yet opened.
+     *  The file descriptor with index %G_UNIX_PIPE_END_READ is readable.
+     *  The file descriptor with index %G_UNIX_PIPE_END_WRITE is writable.
+     * @field 
+     */
+    fds: number[]
+}
+
+/**
+ * A Unix pipe. The advantage of this type over `int[2]` is that it can
+ * be closed automatically when it goes out of scope, using `g_auto(GUnixPipe)`,
+ * on compilers that support that feature.
+ * @record 
+ */
+class Pipe {
+
+    // Own properties of GLibUnix-2.0.GLibUnix.Pipe
+
+    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 GLibUnix;
+// END

package/glibunix-2.0.js

@@ -0,0 +1,10 @@
+
+
+  // @ts-expect-error
+  import GLibUnix from 'gi://GLibUnix?version=2.0';
+  export { GLibUnix };
+  export default GLibUnix;
+
+
+
+

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@girs/glibunix-2.0",
+  "version": "2.0.0-3.3.0",
+  "description": "GJS TypeScript type definitions for GLibUnix-2.0, generated from library version 2.0.0",
+  "type": "module",
+  "module": "glibunix-2.0.js",
+  "main": "glibunix-2.0.js",
+  "exports": {
+    "./ambient": {
+      "types": "./glibunix-2.0-ambient.d.ts",
+      "default": "./glibunix-2.0-ambient.js"
+    },
+    "./import": {
+      "types": "./glibunix-2.0-import.d.ts",
+      "default": "./glibunix-2.0-import.js"
+    },
+    ".": {
+      "import": {
+        "types": "./glibunix-2.0.d.ts",
+        "default": "./glibunix-2.0.js"
+      },
+      "require": {
+        "types": "./glibunix-2.0.d.cts",
+        "default": "./glibunix-2.0.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "test": "yarn test:esm && yarn test:cjs",
+    "test:esm": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit glibunix-2.0.d.ts",
+    "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit glibunix-2.0.d.cts"
+  },
+  "dependencies": {
+    "@girs/gjs": "^3.3.0",
+    "@girs/glib-2.0": "^2.78.0-3.3.0",
+    "@girs/gobject-2.0": "^2.78.0-3.3.0"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "GLibUnix-2.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/glibunix-2.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": ["./glibunix-2.0.d.ts"]
+}
+
+

package/typedoc.json

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