release v7.3.4

gramiojs · May 10, 2024 · 0919cd1 · 0919cd1
1 parent 8a6d8e4
commit 0919cd1
Show file tree

Hide file tree

Showing 8 changed files with 445 additions and 9 deletions.
diff --git a/hash.txt b/hash.txt
@@ -1 +1 @@
-please regenerate 🥺🥺🥺
+14e6870ea001bb26dc5a49d766dc7f4a273be53a
diff --git a/jsr.json b/jsr.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://jsr.io/schema/config-file.v1.json",
   "name": "@gramio/types",
-  "version": "7.3.1",
+  "version": "7.3.4",
   "exports": {
     ".": "./source/index.ts",
     "./methods": "./source/methods.ts",

diff --git a/out/index.d.ts b/out/index.d.ts
@@ -1,3 +1,18 @@
+/**
+ * @module
+ *
+ * This module re-export another modules (+ export params as TelegramParams/objects as TelegramObjects)
+ *
+ * @example import
+ * ```typescript
+ * import { TelegramUser, SendMessageParams, APIMethods, APIMethodReturn } from "@gramio/types";
+ * ```
+ *
+ * Based on Bot API v7.3.0 (06.05.2024)
+ *
+ * Generated at 10.05.2024, 19:21:08 using [types](https://github.com/gramiojs/types) and [schema](https://ark0f.github.io/tg-bot-api) generators
+ */
+
 export type * from "./methods"
 export type * from "./params"
 export type * as TelegramParams from "./params"

diff --git a/out/methods.d.ts b/out/methods.d.ts
@@ -1,7 +1,21 @@
 /**
- * Based on Bot API v7.3.0 (6.5.2024)
- * Generated at 5/7/2024, 6:19:33 PM using [types](https://github.com/gramiojs/types) and [schema](https://ark0f.github.io/tg-bot-api) generators
+ * @module
+ *
+ * This module contains [API methods](https://core.telegram.org/bots/api#available-methods) types (functions map with input/output)
+ *
+ * @example import API methods map
+ * ```typescript
+ * import { APIMethods } from "@gramio/types/methods";
+ *
+ * type SendMessageReturn = Awaited<ReturnType<APIMethods["sendMessage"]>>;
+ * //   ^? type SendMessageReturn = TelegramMessage"
+ * ```
+ *
+ * Based on Bot API v7.3.0 (06.05.2024)
+ *
+ * Generated at 10.05.2024, 19:21:08 using [types](https://github.com/gramiojs/types) and [schema](https://ark0f.github.io/tg-bot-api) generators
  */
+
 import type {
     CallAPIWithOptionalParams,
     CallAPI,
@@ -10,6 +24,9 @@ import type {
 import type * as Params from "./params"
 import type * as Objects from "./objects"
 
+/**
+ * This object is a map of [API methods](https://core.telegram.org/bots/api#available-methods) types (functions map with input/output)
+ */
 export interface APIMethods {
     /**
      * Use this method to receive incoming updates using long polling ([wiki](https://en.wikipedia.org/wiki/Push_technology#Long_polling)). Returns an Array of [Update](https://core.telegram.org/bots/api/#update) objects.

diff --git a/out/objects.d.ts b/out/objects.d.ts
@@ -1,6 +1,16 @@
 /**
- * Based on Bot API v7.3.0 (6.5.2024)
- * Generated at 5/7/2024, 6:19:33 PM using [types](https://github.com/gramiojs/types) and [schema](https://ark0f.github.io/tg-bot-api) generators
+ * @module
+ *
+ * This module contains [Objects](https://core.telegram.org/bots/api#available-types) with the `Telegram` prefix
+ *
+ * @example import object
+ * ```typescript
+ * import { TelegramUser } from "@gramio/types/objects";
+ * ```
+ *
+ * Based on Bot API v7.3.0 (06.05.2024)
+ *
+ * Generated at 10.05.2024, 19:21:08 using [types](https://github.com/gramiojs/types) and [schema](https://ark0f.github.io/tg-bot-api) generators
  */
 
 /**