protobuf.js icon indicating copy to clipboard operation
protobuf.js copied to clipboard

Published 20 hours ago • verified publisher icon protobufjs

Don't include `@exports` for enums

Open jolting opened this issue 2 years ago • 5 comments

jsdoc states :

Use the @exports tag when documenting JavaScript modules that export anything" other than the "exports" object or the "module.exports" property.

It is not intended to be used to specify an export name. TLDR: There should be only one @exports per file. Maybe $root for non-es6 modules. ES6 modules should use @module

The other @exports don't appear to be causing problems. However, they are incorrect as well.

Fixes #1414

jolting avatar Oct 12 '22 01:10 jolting

I have tested it. It is really solves my issue where pbts does not generate interfaces for enum but use implements from interfases which does not exists.

VitalyName avatar Oct 25 '22 15:10 VitalyName

Good news! I have been waiting this fix for 2 years!

AlexeySource avatar Oct 25 '22 15:10 AlexeySource

Also it fixes other my issue. Once I was surprised when building of my project was broken, despite the fact that I locked the dependency tree. Fixes: https://github.com/protobufjs/protobuf.js/issues/1413

VitalyName avatar Oct 25 '22 15:10 VitalyName

@bcoe @alexander-fenster please pardon my ping but what is preventing this pr from being merged?

ayZagen avatar Aug 03 '23 08:08 ayZagen

https://github.com/protobufjs/protobuf.js/pull/1999

jaovitubr avatar Jun 02 '24 17:06 jaovitubr