README
@handy-common-utils/dev-utils
Utilities for the convenience of developers
How to use
Normally you don't use this package directly.
Instead, you add @handy-common-utils/dev-dependencies
as a dev dependency:
npm install -D @handy-common-utils/dev-dependencies
That's all.
After installation, the command line generate-api-docs-and-update-readme
will be available in your project.
This command line can update the <!--
API start
-->...<!--
API end
-->
section
in your README.md
with generated API documentation.
API
@handy-common-utils/dev-utils
@handy-common-utils/dev-utils
Table of contents
Modules
Classes
@handy-common-utils/dev-utils / dev-utils / DevUtils
Class: DevUtils
dev-utils.DevUtils
Table of contents
Constructors
Methods
Constructors
constructor
• new DevUtils()
Methods
generateApiDocsAndUpdateReadme
▸ Static
generateApiDocsAndUpdateReadme(): Promise
<void
>
Returns
Promise
<void
>
generateApiDocsMd
▸ Static
generateApiDocsMd(): Promise
<void
>
Returns
Promise
<void
>
Modules
@handy-common-utils/dev-utils / dev-utils