@compodoc/compodoc
Version:
The missing documentation tool for your Angular application
525 lines (450 loc) • 21 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>sample-files documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">sample-files documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content module">
<div class="content-data">
<ol class="breadcrumb">
<li>Modules</li>
<li >AppModule</li>
</ol>
<div class="text-center module-graph-container">
<div id="module-graph-svg">
<!-- Generated by graphviz version 2.47.3 (20210619.1520)
-->
<!-- Title: dependencies Pages: 1 -->
<svg width="722pt" height="247pt"
viewBox="0.00 0.00 722.00 246.80" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 242.8)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-242.8 718,-242.8 718,4 -4,4"/>
<text text-anchor="middle" x="357" y="-8.2" font-family="sans-serif" font-size="14.00">dependencies</text>
<g id="clust1" class="cluster">
<title>cluster_AppModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-32.8 8,-230.8 706,-230.8 706,-32.8 8,-32.8"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_AppModule_imports</title>
<polygon fill="none" stroke="black" points="442,-40.8 442,-92.8 698,-92.8 698,-40.8 442,-40.8"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_AppModule_bootstrap</title>
<polygon fill="none" stroke="black" points="289,-170.8 289,-222.8 413,-222.8 413,-170.8 289,-170.8"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_AppModule_providers</title>
<polygon fill="none" stroke="black" points="146,-40.8 146,-92.8 434,-92.8 434,-40.8 146,-40.8"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_AppModule_declarations</title>
<polygon fill="none" stroke="black" points="16,-40.8 16,-92.8 138,-92.8 138,-40.8 16,-40.8"/>
</g>
<!-- AppComponent -->
<g id="node1" class="node">
<title>AppComponent</title>
<polygon fill="#ffffb3" stroke="black" points="129.94,-84.8 24.06,-84.8 24.06,-48.8 129.94,-48.8 129.94,-84.8"/>
<text text-anchor="middle" x="77" y="-62.6" font-family="Times,serif" font-size="14.00">AppComponent</text>
</g>
<!-- AppModule -->
<g id="node2" class="node">
<title>AppModule</title>
<polygon fill="#8dd3c7" stroke="black" points="392.66,-149.8 389.66,-153.8 368.66,-153.8 365.66,-149.8 309.34,-149.8 309.34,-113.8 392.66,-113.8 392.66,-149.8"/>
<text text-anchor="middle" x="351" y="-127.6" font-family="Times,serif" font-size="14.00">AppModule</text>
</g>
<!-- AppComponent->AppModule -->
<g id="edge1" class="edge">
<title>AppComponent->AppModule</title>
<path fill="none" stroke="black" d="M77,-85.08C77,-106.12 77,-137.8 77,-137.8 77,-137.8 299.09,-137.8 299.09,-137.8"/>
<polygon fill="black" stroke="black" points="299.09,-141.3 309.09,-137.8 299.09,-134.3 299.09,-141.3"/>
</g>
<!-- AppComponent -->
<g id="node5" class="node">
<title>AppComponent </title>
<polygon fill="#80b1d3" stroke="black" points="405.44,-214.8 296.56,-214.8 296.56,-178.8 405.44,-178.8 405.44,-214.8"/>
<text text-anchor="middle" x="351" y="-192.6" font-family="Times,serif" font-size="14.00">AppComponent </text>
</g>
<!-- AppModule->AppComponent -->
<g id="edge4" class="edge">
<title>AppModule->AppComponent </title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M351,-149.91C351,-149.91 351,-168.79 351,-168.79"/>
<polygon fill="black" stroke="black" points="347.5,-168.79 351,-178.79 354.5,-168.79 347.5,-168.79"/>
</g>
<!-- AppRoutingModule -->
<g id="node3" class="node">
<title>AppRoutingModule</title>
<polygon fill="#8dd3c7" stroke="black" points="690.27,-84.8 687.27,-88.8 666.27,-88.8 663.27,-84.8 561.73,-84.8 561.73,-48.8 690.27,-48.8 690.27,-84.8"/>
<text text-anchor="middle" x="626" y="-62.6" font-family="Times,serif" font-size="14.00">AppRoutingModule</text>
</g>
<!-- AppRoutingModule->AppModule -->
<g id="edge2" class="edge">
<title>AppRoutingModule->AppModule</title>
<path fill="none" stroke="black" d="M626,-85.08C626,-106.12 626,-137.8 626,-137.8 626,-137.8 402.77,-137.8 402.77,-137.8"/>
<polygon fill="black" stroke="black" points="402.77,-134.3 392.77,-137.8 402.77,-141.3 402.77,-134.3"/>
</g>
<!-- HomeModule -->
<g id="node4" class="node">
<title>HomeModule</title>
<polygon fill="#8dd3c7" stroke="black" points="543.76,-84.8 540.76,-88.8 519.76,-88.8 516.76,-84.8 450.24,-84.8 450.24,-48.8 543.76,-48.8 543.76,-84.8"/>
<text text-anchor="middle" x="497" y="-62.6" font-family="Times,serif" font-size="14.00">HomeModule</text>
</g>
<!-- HomeModule->AppModule -->
<g id="edge3" class="edge">
<title>HomeModule->AppModule</title>
<path fill="none" stroke="black" d="M497,-84.82C497,-102.17 497,-125.8 497,-125.8 497,-125.8 402.84,-125.8 402.84,-125.8"/>
<polygon fill="black" stroke="black" points="402.84,-122.3 392.84,-125.8 402.84,-129.3 402.84,-122.3"/>
</g>
<!-- NoopInterceptor -->
<g id="node6" class="node">
<title>NoopInterceptor</title>
<ellipse fill="#fdb462" stroke="black" cx="351" cy="-66.8" rx="74.7" ry="18"/>
<text text-anchor="middle" x="351" y="-62.6" font-family="Times,serif" font-size="14.00">NoopInterceptor</text>
</g>
<!-- NoopInterceptor->AppModule -->
<g id="edge5" class="edge">
<title>NoopInterceptor->AppModule</title>
<path fill="none" stroke="black" d="M351,-84.91C351,-84.91 351,-103.79 351,-103.79"/>
<polygon fill="black" stroke="black" points="347.5,-103.79 351,-113.79 354.5,-103.79 347.5,-103.79"/>
</g>
<!-- TodoStore -->
<g id="node7" class="node">
<title>TodoStore</title>
<ellipse fill="#fdb462" stroke="black" cx="206" cy="-66.8" rx="51.61" ry="18"/>
<text text-anchor="middle" x="206" y="-62.6" font-family="Times,serif" font-size="14.00">TodoStore</text>
</g>
<!-- TodoStore->AppModule -->
<g id="edge6" class="edge">
<title>TodoStore->AppModule</title>
<path fill="none" stroke="black" d="M206,-84.82C206,-102.17 206,-125.8 206,-125.8 206,-125.8 299.06,-125.8 299.06,-125.8"/>
<polygon fill="black" stroke="black" points="299.06,-129.3 309.06,-125.8 299.06,-122.3 299.06,-129.3"/>
</g>
</g>
</svg>
</div>
<i id="fullscreen" class="icon ion-ios-resize module-graph-fullscreen-btn" aria-hidden="true"></i>
<div class="btn-group size-buttons">
<button id="zoom-in" class="btn btn-default btn-sm">Zoom in</button>
<button id="reset" class="btn btn-default btn-sm">Reset</button>
<button id="zoom-out" class="btn btn-default btn-sm">Zoom out</button>
</div>
</div>
<script src="../js/libs/svg-pan-zoom.min.js"></script>
<script src="../js/svg-pan-zoom.controls.js"></script>
<ul class="nav nav-tabs" role="tablist">
<li class="active" >
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/app.module.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>The bootstrapper module</p>
</p>
<div class="container-fluid module">
<div class="row">
<div class="col-sm-3">
<h3>Declarations<a href="https://angular.io/api/core/NgModule#declarations" target="_blank"
title="Official documentation about module declarations"><span class="icon ion-ios-information-circle-outline"></span></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/AppComponent.html">AppComponent</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Providers<a href="https://angular.io/api/core/NgModule#providers" target="_blank"
title="Official documentation about module providers"><span class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../interceptors/NoopInterceptor.html">NoopInterceptor</a>
</li>
<li class="list-group-item">
<a href="../injectables/TodoStore.html">TodoStore</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Imports<a href="https://angular.io/api/core/NgModule#imports" target="_blank" title="Official documentation about module imports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../modules/AppRoutingModule.html">AppRoutingModule</a>
</li>
<li class="list-group-item">
<a href="../modules/HomeModule.html">HomeModule</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Bootstrap<a href="https://angular.io/api/core/NgModule#bootstrap" target="_blank"
title="Official documentation about module bootstrap"><span class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/AppComponent.html">AppComponent</a>
</li>
</ul>
</div>
</div>
</div>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="forChild"></a>
<span class="name">
<span class="modifier">Static</span>
<span ><b>forChild</b></span>
<a href="#forChild"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>forChild(config: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="48"
class="link-to-prism">src/app/app.module.ts:48</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Use this method in your other (non root) modules to import the directive/pipe</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>config</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >ModuleWithProviders</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="forRoot"></a>
<span class="name">
<span class="modifier">Static</span>
<span ><b>forRoot</b></span>
<a href="#forRoot"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>forRoot(config: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="43"
class="link-to-prism">src/app/app.module.ts:43</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Use this method in your root module</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>config</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >ModuleWithProviders</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { BrowserModule } from '@angular/platform-browser';
import { NgModule, ModuleWithProviders } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { HttpModule } from '@angular/http';
import { HomeModule } from './home/';
import { AppComponent } from './app.component';
import { TodoStore } from './shared/services/todo.store';
/* Routing Module */
import { AppRoutingModule } from './app-routing.module';
import { HTTP_INTERCEPTORS } from '@angular/common/http';
import { NoopInterceptor } from './shared/interceptors/noopinterceptor.interceptor';
/**
* The bootstrapper module
*/
@NgModule({
declarations: [AppComponent],
imports: [HomeModule, AppRoutingModule],
providers: [
TodoStore,
{
provide: HTTP_INTERCEPTORS,
useClass: NoopInterceptor,
multi: true
},
{
provide: HTTP_INTERCEPTORS,
useFactory: (languageService: GlobalLanguageService) =>
new HttpConfigurationInterceptor(languageService),
deps: [GlobalLanguageService]
}
],
bootstrap: [AppComponent]
})
export class AppModule {
/**
* Use this method in your root module
*/
static forRoot(config: any = {}): ModuleWithProviders {}
/**
* Use this method in your other (non root) modules to import the directive/pipe
*/
static forChild(config: any = {}): ModuleWithProviders {}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'module';
var COMPODOC_CURRENT_PAGE_URL = 'AppModule.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>