Deno•16mo ago

Properly Integrating JSDoc and Type Definitions for Deno and JS

Hi everyone! I’m working on a JavaScript codebase designed for both Deno and browsers. We’re adding documentation and types to publish it on JSR, but I’ve hit some roadblocks.

Issue 1: JSDoc

Using JSDoc for

@param

@param

and

@returns

@returns

doesn’t work with deno doc or JSR—they ignore the types, likely because they rely on

.d.ts

.d.ts

files for type information. This seems limiting for

*.js

*.js

files but might be a technical constraint.

Issue 2: .d.ts Files

I tried using

.d.ts

.d.ts

files following https://docs.deno.com/runtime/fundamentals/typescript/, however:
- Comments in the source and

.d.ts

.d.ts

seems mutually exclusive in

deno doc

deno doc

, forcing me to move all comments in

.d.ts

.d.ts

, leaving the source undocumented.
- While the editor’s language server recognizes the

.d.ts

.d.ts

types for imports (a

main.js

main.js

, but still fails on

add.js

add.js

deno check

deno check

fails on both

main.js

main.js

and

add.js

add.js

with errors like:

error: TS7006 [ERROR]: Parameter 'a' implicitly has an 'any' type.

error: TS7006 [ERROR]: Parameter 'a' implicitly has an 'any' type.

.

Questions:
1. How can I make deno check work with

@ts-self-types

@ts-self-types

for both the source (

add.js

add.js

) and the importer (

main.js

main.js

)?
2. [And/or] Is there any way to make JSDoc types work directly with

deno doc

deno doc

and JSR without

.d.ts

.d.ts

files?

Thanks for any help!

Deno•16mo ago

zer0

Properly Integrating JSDoc and Type Definitions for Deno and JS

@param

@param

and

@returns

@returns

doesn’t work with deno doc or JSR—they ignore the types, likely because they rely on

.d.ts

.d.ts

files for type information. This seems limiting for

*.js

*.js

files but might be a technical constraint.

Issue 2: .d.ts Files

I tried using

.d.ts

.d.ts

files following https://docs.deno.com/runtime/fundamentals/typescript/, however:
- Comments in the source and

.d.ts

.d.ts

seems mutually exclusive in

deno doc

deno doc

, forcing me to move all comments in

.d.ts

.d.ts

, leaving the source undocumented.
- While the editor’s language server recognizes the

.d.ts

.d.ts

types for imports (a

main.js

main.js

, but still fails on

add.js

add.js

deno check

deno check

fails on both

main.js

main.js

and

add.js

add.js

with errors like:

error: TS7006 [ERROR]: Parameter 'a' implicitly has an 'any' type.

error: TS7006 [ERROR]: Parameter 'a' implicitly has an 'any' type.

.

Questions:
1. How can I make deno check work with

@ts-self-types

@ts-self-types

for both the source (

add.js

add.js

) and the importer (

main.js

main.js

)?
2. [And/or] Is there any way to make JSDoc types work directly with

deno doc

deno doc

and JSR without

.d.ts

.d.ts

files?

Thanks for any help!

Properly Integrating JSDoc and Type Definitions for Deno and JS

Similar Threads

Properly Integrating JSDoc and Type Definitions for Deno and JS

Similar Threads

Similar Threads

Similar Threads