Skip to content

generate API docs with api-extractor#435

Closed
jkowalleck wants to merge 3 commits intomainfrom
try-api-extractor
Closed

generate API docs with api-extractor#435
jkowalleck wants to merge 3 commits intomainfrom
try-api-extractor

Conversation

@jkowalleck
Copy link
Member

@jkowalleck jkowalleck commented Jan 27, 2023 •
edited
Loading

related to #57

unfortunately the result fails.

> @cyclonedx/cyclonedx-library@1.9.2 docs:node
> api-extractor run -v -c api-extractor.node.json --typescript-compiler-folder node_modules/typescript


api-extractor 7.34.0  - https://api-extractor.com/

Analysis will use the bundled TypeScript version 4.8.4
*** The target project appears to use TypeScript 4.9.4 which is newer than the bundled compiler engine; consider upgrading API Extractor.

ERROR: The "export * as ___" syntax is not supported yet; as a workaround, use "import * as ___" with a separate "export { ___ }" declaration
/home/flow/Documents/Coding/node/cyclonedx-javascript-library/dist.d/index.node.d.ts:20:8

followup would be to use https://api-extractor.com/pages/setup/generating_docs/
to generate final markdowns ....

@jkowalleck
chore: got microsoft api-extractor configured
038f2be 
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck added the documentation Improvements or additions to documentation label Jan 27, 2023
@jkowalleck
gh workflow to gen docs
d048501 
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck
appi-extractor docModel
9408b60 
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck mentioned this pull request Jan 27, 2023
Closed
@jkowalleck
Copy link
Member Author

jkowalleck commented Jan 27, 2023

Superseded by #436

@jkowalleck jkowalleck closed this Jan 27, 2023
@jkowalleck jkowalleck deleted the try-api-extractor branch January 27, 2023 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jkowalleck