cyclonedx-node-module icon indicating copy to clipboard operation
cyclonedx-node-module copied to clipboard

DOCS: add typehints

Open jkowalleck opened this issue 3 years ago • 0 comments

current implementation is untyped undocumented javascript

as a user of this library i want type docs, so that i know expected parameter types. as a user of this library i want type docs, so that i know possible throws. as a user of this library i want type docs, so that i know possible return types. as a user of this library i want type docs, so that tools/IDE assistance is improved.

options:

  • rewrite the whole thing in typescript.
  • add jsdoc to methods, properties, classes,
  • add type definition files (*.d.ts) to the project

enforce typehints via eslint rules: https://github.com/gajus/eslint-plugin-jsdoc

jkowalleck avatar Dec 08 '21 10:12 jkowalleck