-
-
Notifications
You must be signed in to change notification settings - Fork 601
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(typedoc): add ts docs #571
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,3 +33,6 @@ lerna-debug.log | |
|
|
||
| # Yarn lock file | ||
| yarn.lock | ||
|
|
||
| # docs map | ||
| docs/**/*.map | ||
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
875 changes: 875 additions & 0 deletions
875
docs/classes/_add_node_modules__webpack_cli_generators_add_generator_.addgenerator.html
Large diffs are not rendered by default.
Oops, something went wrong.
875 changes: 875 additions & 0 deletions
875
docs/classes/_generators_add_generator_.addgenerator.html
Large diffs are not rendered by default.
Oops, something went wrong.
909 changes: 909 additions & 0 deletions
909
docs/classes/_generators_init_generator_.initgenerator.html
Large diffs are not rendered by default.
Oops, something went wrong.
902 changes: 902 additions & 0 deletions
902
docs/classes/_generators_remove_generator_.removegenerator.html
Large diffs are not rendered by default.
Oops, something went wrong.
753 changes: 753 additions & 0 deletions
753
docs/classes/_generators_update_generator_.updategenerator.html
Large diffs are not rendered by default.
Oops, something went wrong.
909 changes: 909 additions & 0 deletions
909
docs/classes/_init_node_modules__webpack_cli_generators_init_generator_.initgenerator.html
Large diffs are not rendered by default.
Oops, something went wrong.
902 changes: 902 additions & 0 deletions
902
...asses/_remove_node_modules__webpack_cli_generators_remove_generator_.removegenerator.html
Large diffs are not rendered by default.
Oops, something went wrong.
753 changes: 753 additions & 0 deletions
753
...asses/_update_node_modules__webpack_cli_generators_update_generator_.updategenerator.html
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
283 changes: 283 additions & 0 deletions
283
...pack_cli_generators_node_modules__webpack_cli_utils_package_manager_.ispawnfunctions.html
Large diffs are not rendered by default.
Oops, something went wrong.
422 changes: 422 additions & 0 deletions
422
...pack_cli_generators_node_modules__webpack_cli_webpack_scaffold_index_.iinquirerinput.html
Large diffs are not rendered by default.
Oops, something went wrong.
422 changes: 422 additions & 0 deletions
422
...bpack_cli_generators_node_modules__webpack_cli_webpack_scaffold_index_.iinquirerlist.html
Large diffs are not rendered by default.
Oops, something went wrong.
446 changes: 446 additions & 0 deletions
446
...generators_node_modules__webpack_cli_webpack_scaffold_index_.iinquirerscaffoldobject.html
Large diffs are not rendered by default.
Oops, something went wrong.
254 changes: 254 additions & 0 deletions
254
.../interfaces/_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,254 @@ | ||
| <!doctype html> | ||
| <html class="default no-js"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <title>ISchemaProperties | webpack-cli</title> | ||
| <meta name="description" content=""> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <link rel="stylesheet" href="../assets/css/main.css"> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| <div class="tsd-page-toolbar"> | ||
| <div class="container"> | ||
| <div class="table-wrap"> | ||
| <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> | ||
| <div class="field"> | ||
| <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> | ||
| <input id="tsd-search-field" type="text" /> | ||
| </div> | ||
| <ul class="results"> | ||
| <li class="state loading">Preparing search index...</li> | ||
| <li class="state failure">The search index is not available</li> | ||
| </ul> | ||
| <a href="../index.html" class="title">webpack-cli</a> | ||
| </div> | ||
| <div class="table-cell" id="tsd-widgets"> | ||
| <div id="tsd-filter"> | ||
| <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> | ||
| <div class="tsd-filter-group"> | ||
| <div class="tsd-select" id="tsd-filter-visibility"> | ||
| <span class="tsd-select-label">All</span> | ||
| <ul class="tsd-select-list"> | ||
| <li data-value="public">Public</li> | ||
| <li data-value="protected">Public/Protected</li> | ||
| <li data-value="private" class="selected">All</li> | ||
| </ul> | ||
| </div> | ||
| <input type="checkbox" id="tsd-filter-inherited" checked /> | ||
| <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> | ||
| <input type="checkbox" id="tsd-filter-externals" checked /> | ||
| <label class="tsd-widget" for="tsd-filter-externals">Externals</label> | ||
| <input type="checkbox" id="tsd-filter-only-exported" /> | ||
| <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> | ||
| </div> | ||
| </div> | ||
| <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="tsd-page-title"> | ||
| <div class="container"> | ||
| <ul class="tsd-breadcrumb"> | ||
| <li> | ||
| <a href="../globals.html">Globals</a> | ||
| </li> | ||
| <li> | ||
| <a href="../modules/_add_node_modules__webpack_cli_generators_types_index_.html">"add/node_modules/@webpack-cli/generators/types/index"</a> | ||
| </li> | ||
| <li> | ||
| <a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html">ISchemaProperties</a> | ||
| </li> | ||
| </ul> | ||
| <h1>Interface ISchemaProperties</h1> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="container container-main"> | ||
| <div class="row"> | ||
| <div class="col-8 col-content"> | ||
| <section class="tsd-panel tsd-hierarchy"> | ||
| <h3>Hierarchy</h3> | ||
| <ul class="tsd-hierarchy"> | ||
| <li> | ||
| <span class="target">ISchemaProperties</span> | ||
| </li> | ||
| </ul> | ||
| </section> | ||
| <section class="tsd-panel-group tsd-index-group"> | ||
| <h2>Index</h2> | ||
| <section class="tsd-panel tsd-index-panel"> | ||
| <div class="tsd-index-content"> | ||
| <section class="tsd-index-section tsd-is-external"> | ||
| <h3>Properties</h3> | ||
| <ul class="tsd-index-list"> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html#additionalproperties" class="tsd-kind-icon">additional<wbr>Properties</a></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html#definitions" class="tsd-kind-icon">definitions</a></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html#properties" class="tsd-kind-icon">properties</a></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html#type" class="tsd-kind-icon">type</a></li> | ||
| </ul> | ||
| </section> | ||
| </div> | ||
| </section> | ||
| </section> | ||
| <section class="tsd-panel-group tsd-member-group tsd-is-external"> | ||
| <h2>Properties</h2> | ||
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a name="additionalproperties" class="tsd-anchor"></a> | ||
| <h3><span class="tsd-flag ts-flagOptional">Optional</span> additional<wbr>Properties</h3> | ||
| <div class="tsd-signature tsd-kind-icon">additional<wbr>Properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> | ||
| <aside class="tsd-sources"> | ||
| <ul> | ||
| <li>Defined in add/node_modules/@webpack-cli/generators/types/index.ts:2</li> | ||
| </ul> | ||
| </aside> | ||
| </section> | ||
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a name="definitions" class="tsd-anchor"></a> | ||
| <h3><span class="tsd-flag ts-flagOptional">Optional</span> definitions</h3> | ||
| <div class="tsd-signature tsd-kind-icon">definitions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> | ||
| <aside class="tsd-sources"> | ||
| <ul> | ||
| <li>Defined in add/node_modules/@webpack-cli/generators/types/index.ts:3</li> | ||
| </ul> | ||
| </aside> | ||
| </section> | ||
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a name="properties" class="tsd-anchor"></a> | ||
| <h3><span class="tsd-flag ts-flagOptional">Optional</span> properties</h3> | ||
| <div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> | ||
| <aside class="tsd-sources"> | ||
| <ul> | ||
| <li>Defined in add/node_modules/@webpack-cli/generators/types/index.ts:4</li> | ||
| </ul> | ||
| </aside> | ||
| </section> | ||
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a name="type" class="tsd-anchor"></a> | ||
| <h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3> | ||
| <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> | ||
| <aside class="tsd-sources"> | ||
| <ul> | ||
| <li>Defined in add/node_modules/@webpack-cli/generators/types/index.ts:5</li> | ||
| </ul> | ||
| </aside> | ||
| </section> | ||
| </section> | ||
| </div> | ||
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> | ||
| <nav class="tsd-navigation primary"> | ||
| <ul> | ||
| <li class="globals "> | ||
| <a href="../globals.html"><em>Globals</em></a> | ||
| </li> | ||
| <li class="current tsd-kind-external-module tsd-is-external"> | ||
| <a href="../modules/_add_node_modules__webpack_cli_generators_types_index_.html">"add/node_<wbr>modules/@webpack-<wbr>cli/generators/types/index"</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <nav class="tsd-navigation secondary menu-sticky"> | ||
| <ul class="before-current"> | ||
| </ul> | ||
| <ul class="current"> | ||
| <li class="current tsd-kind-interface tsd-parent-kind-external-module tsd-is-external"> | ||
| <a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html" class="tsd-kind-icon">ISchema<wbr>Properties</a> | ||
| <ul> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html#additionalproperties" class="tsd-kind-icon">additional<wbr>Properties</a> | ||
| </li> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html#definitions" class="tsd-kind-icon">definitions</a> | ||
| </li> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html#properties" class="tsd-kind-icon">properties</a> | ||
| </li> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a href="_add_node_modules__webpack_cli_generators_types_index_.ischemaproperties.html#type" class="tsd-kind-icon">type</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <ul class="after-current"> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external"> | ||
| <a href="_add_node_modules__webpack_cli_generators_types_index_.iwebpackoptions.html" class="tsd-kind-icon">IWebpack<wbr>Options</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported"> | ||
| <a href="_add_node_modules__webpack_cli_generators_types_index_.iwebpackresolve.html" class="tsd-kind-icon">IWebpack<wbr>Resolve</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported"> | ||
| <a href="../modules/_add_node_modules__webpack_cli_generators_types_index_.html#irulesetcondition" class="tsd-kind-icon">IRule<wbr>Set<wbr>Condition</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <footer class="with-border-bottom"> | ||
| <div class="container"> | ||
| <h2>Legend</h2> | ||
| <div class="tsd-legend-group"> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> | ||
| <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> | ||
| <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> | ||
| <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> | ||
| <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> | ||
| <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> | ||
| <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> | ||
| <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> | ||
| <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> | ||
| <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> | ||
| <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> | ||
| <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> | ||
| <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> | ||
| <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> | ||
| <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> | ||
| <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> | ||
| <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> | ||
| <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> | ||
| <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> | ||
| <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> | ||
| <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> | ||
| <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> | ||
| <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> | ||
| <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> | ||
| <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| <div class="container tsd-generator"> | ||
| <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> | ||
| </div> | ||
| <div class="overlay"></div> | ||
| <script src="../assets/js/main.js"></script> | ||
| <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more descriptive here please