@grammyjs/types 2.12.0 → 3.0.0

package/README.md

@@ -71,8 +71,9 @@ grammY automatically translates calls to `sendDocument` and the like to multipar
 Consequently, the type `InputFile` is not defined in this library.
 
 Instead, grammY specifies its own version of what an `InputFile` is, hence automatically adjusting `@grammyjs/types` with a custom `InputFile` type used throughout all affected methods and interfaces.
-This is possible by what we call a _proxy type_.
-grammY then imports the proxy type called `InputProxyType` and parametrises it with its version of `InputFile`.
+This is possible by adding a type parameter to all affected types.
+grammY then import types parametrises these types with its version of `InputFile`, and re-exports the adjusted types.
+This is why you should always import Bot API as described here: <https://grammy.dev/guide/api.html#type-definitions-for-the-api>.
 
 ## Differences to the Bot API
 
@@ -91,3 +92,15 @@ The actual type definitions themselves are never different.
    Also, without the links, it's useless anyway.
 5. No images.
    Documentation strings containing an image are adjusted to make sense without the images, too.
+
+## Contributing
+
+This is a Deno project.
+All the files are TypeScript files that are published on <https://deno.land/x/grammy_types>.
+This project uses [deno2node](https://github.com/fromdeno/deno2node) to emit declaration files which are then published on npm.
+
+If you want to work on this, you do not need to have Node.js installed.
+You also should not run `npm install`.
+You only need [Deno](https://deno.land) and the VSCode extensions recommended in this repo.
+
+Run `deno task` to see available development scripts.

package/api.d.ts

@@ -1,25 +1,22 @@
 export interface ApiError {
-  ok: false;
-  error_code: number;
-  description: string;
-  parameters?: ResponseParameters;
+    ok: false;
+    error_code: number;
+    description: string;
+    parameters?: ResponseParameters;
 }
-
 export interface ApiSuccess<T> {
-  ok: true;
-  result: T;
+    ok: true;
+    result: T;
 }
-
 /** The response contains an object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals true, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.
 
 All methods in the Bot API are case-insensitive.
 All queries must be made using UTF-8. */
 export type ApiResponse<T> = ApiError | ApiSuccess<T>;
-
 /** Describes why a request was unsuccessful. */
 export interface ResponseParameters {
-  /** The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. */
-  migrate_to_chat_id?: number;
-  /** In case of exceeding flood control, the number of seconds left to wait before the request can be repeated */
-  retry_after?: number;
+    /** The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. */
+    migrate_to_chat_id?: number;
+    /** In case of exceeding flood control, the number of seconds left to wait before the request can be repeated */
+    retry_after?: number;
 }