@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 pipe"> <div class="content-data"> <ol class="breadcrumb"> <li>Pipes</li> <li class="deprecated-name" >FirstUpperPipe</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="#readme" role="tab" id="readme-tab" data-toggle="tab" data-link="readme">README</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/pipes/first-upper.pipe.ts</code> </p> <p class="comment"> <h3 class="deprecated">Deprecated</h3> </p> <p class="comment"> This pipe is deprecated </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>Uppercase the first letter of the string</p> <p><strong>Usage :</strong> value | firstUpper</p> <p> {{ car | firstUpper}} formats to: Car</p> </p> <section> <h3>Metadata</h3> <table class="table table-sm table-hover"> <tbody> <tr> <td class="col-md-3">Name</td> <td class="col-md-9">firstUpper</td> </tr> <tr> <td class="col-md-3">Pure</td> <td class="col-md-9">true</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="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="61" class="link-to-prism">src/app/shared/pipes/first-upper.pipe.ts:61</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>pipe 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>pipe method return</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="transform"></a> <span class="name"> <span class="deprecated-name"><b>transform</b></span> <a href="#transform"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4 deprecated"> the transform function is deprecated </td> </tr> <tr> <td class="col-md-4"> <code>transform(value: <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="70" class="link-to-prism">src/app/shared/pipes/first-upper.pipe.ts:70</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>the transform function</p> </div> <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>value</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>the value of the pipe</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"> </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="55" class="link-to-prism">src/app/shared/pipes/first-upper.pipe.ts:55</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="cachedUrl"></a> <span class="name"> <span class="modifier">Private</span> <span ><b>cachedUrl</b></span> <a href="#cachedUrl"><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="25" class="link-to-prism">src/app/shared/pipes/first-upper.pipe.ts:25</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Example property</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="emptyProperty"></a> <span class="name"> <span ><b>emptyProperty</b></span> <a href="#emptyProperty"><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="31" class="link-to-prism">src/app/shared/pipes/first-upper.pipe.ts:31</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>pipe property</p> </div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade " id="c-readme"> <p><h1 id="first-upper-pipe">First upper pipe</h1> </p> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Input, Output, PipeTransform, Pipe } from '@angular/core'; const name = 'firstUpper'; const pure = true; /** * Uppercase the first letter of the string * * __Usage :__ * value | firstUpper * * @example * {{ car | firstUpper}} * formats to: Car * @deprecated This pipe is deprecated */ @Pipe({ name, pure }) export class FirstUpperPipe implements PipeTransform { /** * Example property */ private cachedUrl: string = ''; /** * @example * pipe property */ emptyProperty = ''; /** * @example * pipe input */ @Input() public emptyInput: string; /** * @example * pipe output */ @Output() public emptyOutput: string; /** * @example * pipe accessor */ get emptyAccessor() { return this._emptyAccessor; } set emptyAccessor(val) { this._emptyAccessor = val; } private _emptyAccessor = ''; /** * @param emptyParam pipe method param * @returns pipe method return */ emptyMethod(emptyParam: string) { return emptyParam; } /** * the transform function * @deprecated the transform function is deprecated * @param {string} value the value of the pipe */ transform(value: string): string { return value.charAt(0).toUpperCase() + value.slice(1); } } </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 = 'pipe'; var COMPODOC_CURRENT_PAGE_URL = 'FirstUpperPipe.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>