search

datalust / seq-logging

A Node.js client for the Seq HTTP ingestion API
Apache License 2.0
25 stars 15 forks source link

Type definition file 'index.d.ts' is missing jsdoc for methods #42

Closed rj-xy closed 3 years ago

rj-xy commented 3 years ago

AC: As a developer using VSCode (or any TS-aware IDE), I would like the intellisense for functions and class methods (e.g. seq_logger.js) to be displayed with the accompanying comments/jsdocs. This will save me having to look into the source code for definitions, e.g. what is the difference between flush and flushToBeacon

Notes: The package seq-logging definition file (node_modules/seq-logging/index.d.ts) does not have the SeqLogger method comments.

I think perhaps this problem is two-fold:

  1. The methods on node_modules/seq-logging/seq_logger.js are not using the jsdoc format
  2. The type definition file generation process (tsc index.js --declaration --emitDeclarationOnly) should then be run
nblumhardt commented 3 years ago

Thanks for the heads-up! 👍

rj-xy commented 3 years ago

I'll get a PR up for this by the end of next week - otherwise bump me for a reminder

rj-xy commented 3 years ago

Related PR: https://github.com/datalust/seq-logging/pull/44

nblumhardt commented 3 years ago

Fixed in #44