@compodoc/compodoc

<!doctype 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>  <div class="content class"> <div class="content-data"> <ol class="breadcrumb"> <li>Classes</li> <li >Clock</li> </ol> <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/shared/interfaces/interfaces.ts</code> </p> <p class="comment"> <h3>Implements</h3> </p> <p class="comment"> <code><a href="../interfaces/ClockInterface.html" target="_self" >ClockInterface</a></code> </p> <section> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Properties</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Private</span> <a href="#_emptyAccessor" >_emptyAccessor</a> </li> <li> <a href="#currentTime" >currentTime</a> </li> <li> <a href="#emptyHostBinding" >emptyHostBinding</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Methods</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#emptyHostListener" >emptyHostListener</a> </li> <li> <a href="#emptyMethod" >emptyMethod</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Inputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#emptyInput" >emptyInput</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Outputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#emptyOutput" >emptyOutput</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>HostBindings</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#" ></a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>HostListeners</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#" ></a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Accessors</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#emptyAccessor" >emptyAccessor</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section> <h3 id="constructor">Constructor</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>constructor(h: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, m: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="74" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:74</a></div> </td> </tr> <tr> <td class="col-md-4"> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>h</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code> </td> <td> No </td> </tr> <tr> <td>m</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="inputs"> Properties </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="_emptyAccessor"></a> <span class="name"> <span class="modifier">Private</span> <span ><b>_emptyAccessor</b></span> <a href="#_emptyAccessor"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>''</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="74" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:74</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="currentTime"></a> <span class="name"> <span ><b>currentTime</b></span> <a href="#currentTime"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" target="_blank" >Date</a></code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="62" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:62</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>class property</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="emptyHostBinding"></a> <span class="name"> <span ><b>emptyHostBinding</b></span> <a href="#emptyHostBinding"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code> @HostBinding('')<br /> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="82" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:82</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>class hostBinding</p> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="emptyHostListener"></a> <span class="name"> <span ><b>emptyHostListener</b></span> <a href="#emptyHostListener"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>emptyHostListener()</code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code>@HostListener('')<br /></code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="89" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:89</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>class hostListener</p> </div> <div> <b>Example :</b> <div> <pre class="line-numbers"><code class="language-html">class hostListener</code></pre> </div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >void</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="emptyMethod"></a> <span class="name"> <span ><b>emptyMethod</b></span> <a href="#emptyMethod"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>emptyMethod(emptyParam: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="107" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:107</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>emptyParam</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> <td> No </td> <td> <p>class method param</p> </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </div> <div class="io-description"> <p>class method return</p> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="inputs">Inputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="emptyInput"></a> <b>emptyInput</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="95" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:95</a></div> </td> </tr> </tbody> </table> </section> <section> <h3 id="outputs">Outputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="emptyOutput"></a> <b>emptyOutput</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="101" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:101</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>class output</p> </div> </td> </tr> </tbody> </table> </section> <section> <h3>HostBindings</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name=""></a> <span class="name"> <span ><b></b></span> <a href="#"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="82" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:82</a></div> </td> </tr> </tbody> </table> </section> <section> <h3>HostListeners</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name=""></a> <span class="name"> <span ><b></b></span> <a href="#"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="89" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:89</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>class hostListener</p> </div> <div> <b>Example :</b> <div> <pre class="line-numbers"><code class="language-html">class hostListener</code></pre> </div> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="accessors"> Accessors </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="emptyAccessor"></a> <span class="name"><b>emptyAccessor</b><a href="#emptyAccessor"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>get</b><code>emptyAccessor()</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="68" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:68</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>class accessor</p> </div> <div> <b>Example :</b> <div> <pre class="line-numbers"><code class="language-html">class accessor</code></pre> </div> </div> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>set</b><code>emptyAccessor(val)</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="71" class="link-to-prism">src/app/shared/interfaces/interfaces.ts:71</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>val</td> <td> No </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >void</a></code> </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 { HostBinding, HostListener, Input, Output } from '@angular/core'; import { ClockInterface } from './clock.interface'; /** * An interface just for documentation purpose * @deprecated This interface is deprecated */ interface LabelledTodo { title: string; completed: Boolean; editing?: Boolean; readonly x: number; } export interface ValueInRes { ['__allAnd']: boolean; ['__allOr']: boolean; [property: string]: any; } /** * A function type interface just for documentation purpose * ```typescript * let mySearch: SearchFunc; * mySearch = function(source: string, subString: string) { * let result = source.search(subString); * if (result == -1) { * return false; * } * else { * return true; * } * } * ``` */ interface SearchFunc { /** * A function * @param {string} source A string * @param {string} subString A substring */ (source: string, subString: string): boolean; } /** * A indexable interface just for documentation purpose * ```typescript * let myArray: StringArray; * myArray = ["Bob", "Fred"]; * ``` */ interface StringArray { [index: number]: string; } class Clock implements ClockInterface { /** * @example * class property */ currentTime: Date; /** * @example * class accessor */ get emptyAccessor() { return this._emptyAccessor; } set emptyAccessor(val) { this._emptyAccessor = val; } private _emptyAccessor = ''; constructor(h: number, m: number) {} /** * @example * class hostBinding */ @HostBinding('') emptyHostBinding: string; /** * @example * class hostListener */ @HostListener('') emptyHostListener() {} /** * @example * class input */ @Input() public emptyInput: string; /** * @example * class output */ @Output() public emptyOutput: string; /** * @param emptyParam class method param * @returns class method return */ emptyMethod(emptyParam: string) { return emptyParam; } } interface IDATA { value: [number, string, number[]]; value2: [string, string, ...boolean[]]; } </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>  </div> </div> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'class'; var COMPODOC_CURRENT_PAGE_URL = 'Clock.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>