Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: jsdoc for proto types #333

Merged
merged 1 commit into from
Nov 6, 2024
Merged

chore: jsdoc for proto types #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/nestjs-proto-types/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Check failure on line 13 in packages/nestjs-proto-types/src/index.ts

View workflow job for this annotation

GitHub Actions / TypeCheck

Unused '@ts-expect-error' directive. 

Unused '@ts-expect-error' directive.
Raw output 
  11 |  * @typedef {string} ProtoFile - Represents the imported `.proto` file as a string
  12 |  */
> 13 | // @ts-expect-error
     | ^
  14 | declare module '*.proto'
  15 |
declare module '*.proto'
Loading