@girs/arrowflight-23.0 4.3.0 → 4.5.0

package/README.md

@@ -4,82 +4,77 @@
 ![version](https://img.shields.io/npm/v/@girs/arrowflight-23.0)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/arrowflight-23.0)
 
+GJS TypeScript type definitions for ArrowFlight-23.0, generated from library version 23.0.1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
 
-GJS TypeScript type definitions for ArrowFlight-23.0, generated from library version 23.0.1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
+This package contains type declarations only. It ships no runtime code, so it adds
+nothing to your program and works with any bundler or none at all.
 
 ## Install
 
-Install the type definitions with npm:
 ```bash
 npm install @girs/arrowflight-23.0
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/arrowflight-23.0` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/arrowflight-23.0/ambient` | only the `gi://` module declarations |
+| `@girs/arrowflight-23.0/import` | only the `imports.gi` declarations |
+| `@girs/arrowflight-23.0/arrowflight-23.0` | the namespace, without the side-effecting declarations |
+
+## Three ways to import
+
+Which one you use depends on how you write imports elsewhere, not on your toolchain.
+
+### As a module
 
-Import it like any other module:
 ```ts
 import ArrowFlight from '@girs/arrowflight-23.0';
 ```
 
-### Ambient Modules
+### As `gi://`
 
-[Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
-For this you need to include `@girs/arrowflight-23.0` or `@girs/arrowflight-23.0/ambient` in your `tsconfig` or entry point Typescript file:
+GJS resolves `gi://` at runtime. To give it types, reference the package once, either
+from your entry point or from `tsconfig.json`:
 
-`index.ts`:
 ```ts
-import '@girs/arrowflight-23.0'
+import '@girs/arrowflight-23.0';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/arrowflight-23.0"],
-  ...
-}
+{ "include": ["@girs/arrowflight-23.0"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import ArrowFlight from 'gi://ArrowFlight?version=23.0';
 ```
 
-### Global import
-
-GJS's global `imports.gi` works too, with types.
-For this you need to include `@girs/arrowflight-23.0` or `@girs/arrowflight-23.0/import` in your `tsconfig` or entry point Typescript file:
+Referencing `@girs/arrowflight-23.0/ambient` instead pulls in these declarations
+alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
 
-`index.ts`:
-```ts
-import '@girs/arrowflight-23.0'
-```
-
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/arrowflight-23.0"],
-  ...
-}
-```
+### As `imports.gi`
 
-That form carries types as well:
+GJS's global object works the same way, via `@girs/arrowflight-23.0/import`:
 
 ```ts
 const ArrowFlight = imports.gi.ArrowFlight;
 ```
 
-### Bundle
+## Building
 
-Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
+The declarations need no build step. If you bundle, every bundler works, since there is
+no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
+show working setups for several.
 
 ## Other packages
 
-All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
+
 

package/arrowflight-23.0.d.ts

@@ -27,18 +27,21 @@ export namespace ArrowFlight {
     /**
      * The major version.
      * @since 17.0.0
+     * @default 23
      */
     const VERSION_MAJOR: number;
 
     /**
      * The micro version.
      * @since 17.0.0
+     * @default 1
      */
     const VERSION_MICRO: number;
 
     /**
      * The minor version.
      * @since 17.0.0
+     * @default 0
      */
     const VERSION_MINOR: number;
 
@@ -119,17 +122,20 @@ export namespace ArrowFlight {
          * Add a header.
          * @param name A header name.
          * @param value A header value.
+         * @since 9.0.0
          */
         add_header(name: string, value: string): void;
 
         /**
          * Clear all headers.
+         * @since 9.0.0
          */
         clear_headers(): void;
 
         /**
          * Iterates over all headers in the options.
          * @param func The user's callback function.
+         * @since 9.0.0
          */
         foreach_header(func: HeaderFunc): void;
     }
@@ -195,11 +201,15 @@ export namespace ArrowFlight {
          * @param password Password to be used.
          * @param options A {@link ArrowFlight.CallOptions}.
          * @returns `true` on success, `false` if there was an error.
+         * @since 12.0.0
+         * @throws GLib.Error
          */
         authenticate_basic_token(user: string, password: string, options: CallOptions | null): [boolean, string, string];
 
         /**
          * @returns `true` on success, `false` if there was an error.
+         * @since 8.0.0
+         * @throws GLib.Error
          */
         close(): boolean;
 
@@ -207,6 +217,8 @@ export namespace ArrowFlight {
          * @param ticket A {@link ArrowFlight.Ticket}.
          * @param options A {@link ArrowFlight.CallOptions}.
          * @returns The {@link ArrowFlight.StreamReader} to read record batched from the server   on success, `null` on error.
+         * @since 6.0.0
+         * @throws GLib.Error
          */
         do_get(ticket: Ticket, options: CallOptions | null): StreamReader | null;
 
@@ -222,6 +234,8 @@ export namespace ArrowFlight {
          * @param schema A {@link Arrow.Schema}.
          * @param options A {@link ArrowFlight.CallOptions}.
          * @returns The `GAFlighDoPutResult` holding a reader and a writer on success,   `null` on error.
+         * @since 18.0.0
+         * @throws GLib.Error
          */
         do_put(descriptor: Descriptor, schema: Arrow.Schema, options: CallOptions | null): DoPutResult | null;
 
@@ -229,6 +243,8 @@ export namespace ArrowFlight {
          * @param descriptor A {@link ArrowFlight.Descriptor} to be processed.
          * @param options A {@link ArrowFlight.CallOptions}.
          * @returns The returned {@link ArrowFlight.Info} on   success, `null` on error.
+         * @since 9.0.0
+         * @throws GLib.Error
          */
         get_flight_info(descriptor: Descriptor, options: CallOptions | null): Info | null;
 
@@ -236,6 +252,8 @@ export namespace ArrowFlight {
          * @param criteria A {@link ArrowFlight.Criteria}.
          * @param options A {@link ArrowFlight.CallOptions}.
          * @returns The returned list of {@link ArrowFlight.Info} on success, `null` on error.
+         * @since 5.0.0
+         * @throws GLib.Error
          */
         list_flights(criteria: Criteria | null, options: CallOptions | null): Info[] | null;
     }
@@ -455,6 +473,7 @@ export namespace ArrowFlight {
         // Methods
         /**
          * @returns The opaque value used to express a command.   It should be freed with `g_free()` when no longer needed.
+         * @since 5.0.0
          */
         get_command(): string;
     }
@@ -625,11 +644,13 @@ export namespace ArrowFlight {
         /**
          * @param other_descriptor A {@link ArrowFlight.Descriptor} to be compared.
          * @returns `true` if both of them represents the same descriptor,   `false` otherwise.
+         * @since 5.0.0
          */
         equal(other_descriptor: Descriptor): boolean;
 
         /**
          * @returns A descriptor as a string.   It should be freed with `g_free()` when no longer needed.
+         * @since 5.0.0
          */
         to_string(): string;
     }
@@ -765,11 +786,13 @@ export namespace ArrowFlight {
         /**
          * @param other_endpoint A {@link ArrowFlight.Endpoint} to be compared.
          * @returns `true` if both of them represents the same endpoint,   `false` otherwise.
+         * @since 5.0.0
          */
         equal(other_endpoint: Endpoint): boolean;
 
         /**
          * @returns The locations in this endpoint.   It must be freed with `g_list_free()` and `g_object_unref()` when no   longer needed. You can use `g_list_free_full(locations,   g_object_unref)`.
+         * @since 5.0.0
          */
         get_locations(): Location[] | null;
     }
@@ -832,32 +855,39 @@ export namespace ArrowFlight {
         /**
          * @param other_info A {@link ArrowFlight.Info} to be compared.
          * @returns `true` if both of them represents the same information,   `false` otherwise.
+         * @since 5.0.0
          */
         equal(other_info: Info): boolean;
 
         /**
          * @returns The {@link ArrowFlight.Descriptor} of the information.
+         * @since 5.0.0
          */
         get_descriptor(): Descriptor;
 
         /**
          * @returns The list of {@link ArrowFlight.Endpoint} of the information.
+         * @since 5.0.0
          */
         get_endpoints(): Endpoint[];
 
         /**
          * @param options A {@link Arrow.ReadOptions}.
          * @returns Deserialized {@link Arrow.Schema}, `null` on error.
+         * @since 5.0.0
+         * @throws GLib.Error
          */
         get_schema(options: Arrow.ReadOptions | null): Arrow.Schema;
 
         /**
          * @returns The number of total bytes of the information.
+         * @since 5.0.0
          */
         get_total_bytes(): number;
 
         /**
          * @returns The number of total records of the information.
+         * @since 5.0.0
          */
         get_total_records(): number;
     }
@@ -910,16 +940,19 @@ export namespace ArrowFlight {
         /**
          * @param other_location A {@link ArrowFlight.Location} to be compared.
          * @returns `true` if both of them represents the same URI, `false` otherwise.
+         * @since 5.0.0
          */
         equal(other_location: Location): boolean;
 
         /**
          * @returns The scheme of this URI.   It should be freed with `g_free()` when no longer needed.
+         * @since 5.0.0
          */
         get_scheme(): string;
 
         /**
          * @returns A representation of this URI as a string.   It should be freed with `g_free()` when no longer needed.
+         * @since 5.0.0
          */
         to_string(): string;
     }
@@ -972,6 +1005,7 @@ export namespace ArrowFlight {
         // Methods
         /**
          * @returns The descriptor for this upload.
+         * @since 14.0.0
          */
         get_descriptor(): Descriptor;
     }
@@ -1031,6 +1065,8 @@ export namespace ArrowFlight {
         // Methods
         /**
          * @returns The metadata on success, `null` on error.
+         * @since 18.0.0
+         * @throws GLib.Error
          */
         read(): Arrow.Buffer;
     }
@@ -1092,6 +1128,8 @@ export namespace ArrowFlight {
          * Writes metadata to the client.
          * @param metadata A {@link Arrow.Buffer} to be sent.
          * @returns `true` on success, `false` on error.
+         * @since 18.0.0
+         * @throws GLib.Error
          */
         write(metadata: Arrow.Buffer): boolean;
     }
@@ -1145,6 +1183,7 @@ export namespace ArrowFlight {
         // Methods
         /**
          * @returns The paths in this descriptor.   It must be freed with `g_strfreev()` when no longer needed.
+         * @since 5.0.0
          */
         get_paths(): string[] | null;
     }
@@ -1219,11 +1258,15 @@ export namespace ArrowFlight {
         // Methods
         /**
          * @returns The all data on success, `null` on error.
+         * @since 6.0.0
+         * @throws GLib.Error
          */
         read_all(): Arrow.Table;
 
         /**
          * @returns The next chunk on success, `null` on end   of stream, `null` on error.
+         * @since 6.0.0
+         * @throws GLib.Error
          */
         read_next(): StreamChunk;
     }
@@ -1337,6 +1380,8 @@ export namespace ArrowFlight {
          * @param schema A {@link Arrow.Schema}.
          * @param options A {@link Arrow.WriteOptions}.
          * @returns `true` on success, `false` on error.
+         * @since 18.0.0
+         * @throws GLib.Error
          */
         begin(schema: Arrow.Schema, options: Arrow.WriteOptions | null): boolean;
 
@@ -1344,6 +1389,8 @@ export namespace ArrowFlight {
          * Write metadata.
          * @param metadata A {@link Arrow.Buffer}.
          * @returns `true` on success, `false` on error.
+         * @since 18.0.0
+         * @throws GLib.Error
          */
         write_metadata(metadata: Arrow.Buffer): boolean;
 
@@ -1352,6 +1399,8 @@ export namespace ArrowFlight {
          * @param record_batch A {@link Arrow.RecordBatch}.
          * @param metadata A {@link Arrow.Buffer}.
          * @returns `true` on success, `false` on error.
+         * @since 18.0.0
+         * @throws GLib.Error
          */
         write_record_batch(record_batch: Arrow.RecordBatch, metadata: Arrow.Buffer | null): boolean;
 
@@ -1409,6 +1458,7 @@ export namespace ArrowFlight {
          * A virtual function to implement `DoGet` API.
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param ticket A {@link ArrowFlight.Ticket}.
+         * @since 6.0.0
          * @virtual
          */
         vfunc_do_get(context: ServerCallContext, ticket: Ticket): DataStream;
@@ -1418,6 +1468,7 @@ export namespace ArrowFlight {
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param reader A {@link ArrowFlight.MessageReader}.
          * @param writer A {@link ArrowFlight.MetadataWriter}.
+         * @since 18.0.0
          * @virtual
          */
         vfunc_do_put(context: ServerCallContext, reader: MessageReader, writer: MetadataWriter): boolean;
@@ -1425,6 +1476,7 @@ export namespace ArrowFlight {
         /**
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param request A {@link ArrowFlight.Descriptor}.
+         * @since 9.0.0
          * @virtual
          */
         vfunc_get_flight_info(context: ServerCallContext, request: Descriptor): Info;
@@ -1433,6 +1485,7 @@ export namespace ArrowFlight {
          * A virtual function to implement `ListFlights` API.
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param criteria A {@link ArrowFlight.Criteria}.
+         * @since 5.0.0
          * @virtual
          */
         vfunc_list_flights(context: ServerCallContext, criteria: Criteria | null): Info[];
@@ -1442,6 +1495,8 @@ export namespace ArrowFlight {
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param ticket A {@link ArrowFlight.Ticket}.
          * @returns {@link ArrowFlight.DataStream} on success, `null` on error.
+         * @since 6.0.0
+         * @throws GLib.Error
          */
         do_get(context: ServerCallContext, ticket: Ticket): DataStream;
 
@@ -1451,6 +1506,8 @@ export namespace ArrowFlight {
          * @param reader A {@link ArrowFlight.MessageReader}.
          * @param writer A {@link ArrowFlight.MetadataWriter}.
          * @returns `true` on success, `false` on error.
+         * @since 18.0.0
+         * @throws GLib.Error
          */
         do_put(context: ServerCallContext, reader: MessageReader, writer: MetadataWriter): boolean;
 
@@ -1458,6 +1515,8 @@ export namespace ArrowFlight {
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param request A {@link ArrowFlight.Descriptor}.
          * @returns A {@link ArrowFlight.Info} on success, `null` on error.
+         * @since 9.0.0
+         * @throws GLib.Error
          */
         get_flight_info(context: ServerCallContext, request: Descriptor): Info;
 
@@ -1467,12 +1526,16 @@ export namespace ArrowFlight {
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param criteria A {@link ArrowFlight.Criteria}.
          * @returns {@link GLib.List} of {@link ArrowFlight.Info} on success, `null` on error.
+         * @since 5.0.0
+         * @throws GLib.Error
          */
         list_flights(context: ServerCallContext, criteria: Criteria | null): Info[];
 
         /**
          * @param options A {@link ArrowFlight.ServerOptions}.
          * @returns `true` on success, `false` on error.
+         * @since 5.0.0
+         * @throws GLib.Error
          */
         listen(options: ServerOptions): boolean;
 
@@ -1480,9 +1543,14 @@ export namespace ArrowFlight {
          * Shuts down the serve. This function can be called from signal
          * handler or another thread.
          * @returns `true` on success, `false` on error.
+         * @since 5.0.0
+         * @throws GLib.Error
          */
         shutdown(): boolean;
 
+        /**
+         * @throws GLib.Error
+         */
         wait(): boolean;
     }
 
@@ -1595,6 +1663,8 @@ export namespace ArrowFlight {
         /**
          * Reads a message from the client.
          * @returns Read data as {@link GLib.Bytes} on   success, `null` on error.
+         * @since 12.0.0
+         * @throws GLib.Error
          */
         read(): GLib.Bytes | null;
     }
@@ -1656,6 +1726,8 @@ export namespace ArrowFlight {
          * Writes a message to the client.
          * @param message A {@link GLib.Bytes} to be sent.
          * @returns `true` on success, `false` on error.
+         * @since 12.0.0
+         * @throws GLib.Error
          */
         write(message: GLib.Bytes | Uint8Array): boolean;
     }
@@ -1722,6 +1794,7 @@ export namespace ArrowFlight {
         /**
          * Iterates over all incoming headers.
          * @param func The user's callback function.
+         * @since 14.0.0
          */
         foreach_incoming_header(func: HeaderFunc): void;
     }
@@ -1777,6 +1850,7 @@ export namespace ArrowFlight {
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param sender A {@link ArrowFlight.ServerAuthSender}.
          * @param reader A {@link ArrowFlight.ServerAuthReader}.
+         * @since 12.0.0
          * @virtual
          */
         vfunc_authenticate(context: ServerCallContext, sender: ServerAuthSender, reader: ServerAuthReader): void;
@@ -1785,6 +1859,7 @@ export namespace ArrowFlight {
          * Validates a per-call client token.
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param token The client token. May be the empty string if the client does not   provide a token.
+         * @since 12.0.0
          * @virtual
          */
         vfunc_is_valid(context: ServerCallContext, token: GLib.Bytes): GLib.Bytes | Uint8Array | null;
@@ -1796,6 +1871,8 @@ export namespace ArrowFlight {
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param sender A {@link ArrowFlight.ServerAuthSender}.
          * @param reader A {@link ArrowFlight.ServerAuthReader}.
+         * @since 12.0.0
+         * @throws GLib.Error
          */
         authenticate(context: ServerCallContext, sender: ServerAuthSender, reader: ServerAuthReader): void;
 
@@ -1804,6 +1881,8 @@ export namespace ArrowFlight {
          * @param context A {@link ArrowFlight.ServerCallContext}.
          * @param token The client token. May be the empty string if the client does not   provide a token.
          * @returns The identity of the peer, if   this authentication method supports it.
+         * @since 12.0.0
+         * @throws GLib.Error
          */
         is_valid(context: ServerCallContext, token: GLib.Bytes | Uint8Array): GLib.Bytes | null;
     }
@@ -1937,6 +2016,7 @@ export namespace ArrowFlight {
         // Methods
         /**
          * @returns The data of the chunk.
+         * @since 6.0.0
          */
         get_data(): Arrow.RecordBatch;
 
@@ -1948,6 +2028,7 @@ export namespace ArrowFlight {
 
         /**
          * @returns The metadata of the chunk.   The metadata may be NULL.
+         * @since 6.0.0
          */
         get_metadata(): Arrow.Buffer | null;
     }
@@ -2045,6 +2126,8 @@ export namespace ArrowFlight {
         // Methods
         /**
          * @returns `true` on success, `false` on error.
+         * @since 18.0.0
+         * @throws GLib.Error
          */
         done_writing(): boolean;
     }
@@ -2110,6 +2193,7 @@ export namespace ArrowFlight {
         /**
          * @param other_ticket A {@link ArrowFlight.Ticket} to be compared.
          * @returns `true` if both of them represents the same ticket, `false` otherwise.
+         * @since 5.0.0
          */
         equal(other_ticket: Ticket): boolean;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/arrowflight-23.0",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "libraryVersion": "23.0.1",
     "description": "GJS TypeScript type definitions for ArrowFlight-23.0, generated from library version 23.0.1",
     "type": "module",
@@ -32,12 +32,12 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.3.0",
-      "@girs/arrow-23.0": "^4.3.0",
-      "@girs/gio-2.0": "^4.3.0",
-      "@girs/gobject-2.0": "^4.3.0",
-      "@girs/glib-2.0": "^4.3.0",
-      "@girs/gmodule-2.0": "^4.3.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/arrow-23.0": "^4.5.0",
+      "@girs/gio-2.0": "^4.5.0",
+      "@girs/gobject-2.0": "^4.5.0",
+      "@girs/glib-2.0": "^4.5.0",
+      "@girs/gmodule-2.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },