UNPKG

@compodoc/compodoc

Version:

The missing documentation tool for your Angular application

236 lines (163 loc) 6.72 kB
<!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> <!-- START CONTENT --> <div class="content class"> <div class="content-data"> <ol class="breadcrumb"> <li>Classes</li> <li >StringIndexedItems</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/miscellaneous/miscellaneous.ts</code> </p> <section> <h3 id="inputs">Indexable</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>[index: string]: <code>T</code> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="19" class="link-to-prism">src/app/shared/miscellaneous/miscellaneous.ts:19</a></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">export const PI: number &#x3D; 3.14; export let PIT &#x3D; 4; /** * A foo bar function. Test link for other class {@link ListComponent} * * @param {string} status A status */ export function foo(status: string &#x3D; &#x27;toto&#x27;): string { console.log(&#x27;bar&#x27;); return &#x27;yo&#x27;; } export class StringIndexedItems&lt;T&gt; { [index: string]: T; } export interface TOTsdosds&lt;T&gt; { [yala: string]: T; } /** * Directions of the app */ export enum Direction { Up, Down, Left, Right } /* export type Something &#x3D; number | string; export type Flags &#x3D; { option1: boolean; option2: boolean; } export let yo:{ [index:string] : {message: string} } &#x3D; {}; */ export type ChartChange &#x3D; &#x27;creating&#x27; | &#x27;created&#x27; | &#x27;updating&#x27; | &#x27;updated&#x27;; export type TableColumnTarget &#x3D; number | string | (number | string)[]; export type TableSyncRenderer &#x3D; Type&lt;TableCellRendererBase&gt; | TemplateRef&lt;any&gt;; import { Todo } from &#x27;../models/todo.model&#x27;; export type LinearDomain &#x3D; [number, number]; export type LinearTodo &#x3D; [Todo, Todo]; export type TypeOrTypeArray &#x3D; string | symbol | Array&lt;string | symbol&gt;; export type RouterAdapterOptions &#x3D; Pick&lt;NavigationExtras, &#x27;replaceUrl&#x27;&gt;; type Foo &#x3D; &#x27;320&#x27; | &#x27;360&#x27; | &#x27;1440&#x27;; type Bar &#x3D; &#x60;(min-width: ${Foo}px)&#x60;; function sumFunction0({ a &#x3D; 0, b &#x3D; 1, c &#x3D; 2 }: { a: number; b: number; c: number }) { return a + b + c; } function sumFunction(trackId, { a, b, c }: { a: number; b: number; c: number }, test: string) { return a + b + c; } var [first, second, third] &#x3D; [&#x27;Laide&#x27;, &#x27;Gabriel&#x27;, &#x27;Jets&#x27;]; </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 = 'class'; var COMPODOC_CURRENT_PAGE_URL = 'StringIndexedItems.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>