chore: jsdoc for proto types (#333)

atls · Nov 6, 2024 · bd85c8d · bd85c8d
1 parent d3facb1
commit bd85c8d
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/packages/nestjs-proto-types/src/index.ts b/packages/nestjs-proto-types/src/index.ts
@@ -1 +1,14 @@
+/**
+ * Declares a module for `.proto` files, which are commonly used for defining
+ * Protocol Buffers (protobuf) schemas.
+ *
+ * This declaration allows TypeScript to recognize `.proto` files as modules
+ * that can be imported directly in TypeScript projects, enabling integration
+ * with Protocol Buffers in environments where `.proto` files are parsed or
+ * used as source definitions for generating classes and types.
+ *
+ * @module
+ * @typedef {string} ProtoFile - Represents the imported `.proto` file as a string
+ */
+// @ts-expect-error
 declare module '*.proto'