node-id3 icon indicating copy to clipboard operation
node-id3 copied to clipboard

Setup API Extractor and documenter

Open pbricout opened this issue 3 years ago • 0 comments

Can be reviewed commit by commit, each commit contains a message with details.

Unfortunately, it seems the API-extractor/API-documenter, does not deal well with callable interfaces and types and especially the ones with overloads. I could find an easy to document the overloads. Currently the documentation for each overload of the ReadCallback is ignored.

Summary of the commit messages:

Simplify index exports Anything in these files should be exported, let's simplify. API Extractor examples look like this.

Reformat tsconfig.json Change the identation to 4. Reformat using reformat in VSCode. This will make review easier.

Setup API Extractor and API Documenter Initialisation steps:

  • npx api-extractor init to generate the initial configuration
  • mkdir config (following recommended practices)
  • mv api-extractor.json config/api-extractor.jsonc

Output folder etc will produce the report it is recommended to keep this report to track and review API differences. Output folder doc will contain the API documentation in markdown format.

Change build folder from dist to lib which is the api-extractor default (so following api-extractor recommended).

See: https://api-extractor.com/ https://api-extractor.com/pages/setup/generating_docs/

Configure API extractor

Add TSDoc public tags

Update package.json

Add more API documentation

pbricout avatar Dec 09 '22 10:12 pbricout