coveo-search-ui

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IFieldOption | Coveo JavaScript Search Framework - Reference Documentation</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="https://use.typekit.net/bqa0xml.css"></link> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/all.min.css" /> <link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/overrides.css"> <link rel="stylesheet" href="../assets/css/coveo-connect-header.css"> <link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10122/css/CoveoFullSearch.min.css" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script> <script type="text/javascript" src="https://static.cloud.coveo.com/coveo.analytics.js/coveoua.js"></script> <script src="../assets/js/modernizr.js"></script> <script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10122/js/CoveoJsSearch.min.js"></script> <script src="../assets/js/coveo-connect-header.js"></script> <script src="../assets/gen/js/playground.js"></script> <script src="../assets/js/searchUIrefDoc.js"></script> <link href="../assets/favicon.ico" rel="shortcut icon" type="image/x-icon"> </head> <body> <header class="no-sticky"> <div class="content"> <div class="main-header"> <div class="logo"> <a class="logo-img-wrap" href="https://coveo.com"> <div class="logo-imgbg"> <svg width="124" height="32" viewBox="0 0 409 104" fill="none" xmlns="http://www.w3.org/2000/svg"> <g clip-path="url(#clip0)"> <path d="M164.7 36.2L159.8 41.4C156.4 38.1 152.8 36.2 147.9 36.2C139.4 36.2 133 42.9 133 52.3C133 61.7 139.4 68.4 147.9 68.4C152.5 68.4 156.9 66.5 160.1 63.2L164.7 68.4C160.7 73 155 75.4 148.3 75.4C134.3 75.4 125.2 65.4 125.2 52.3C125.2 38.9 134.3 28.9 148.3 28.9C154.6 28.8 160.6 31.5 164.7 36.2Z" fill="white"/> <path d="M219.4 52.3C219.4 65.4 209.4 75.4 196 75.4C182.3 75.4 172.3 65.4 172.3 52.3C172.3 38.9 182.3 28.9 196 28.9C209.4 28.9 219.4 38.9 219.4 52.3ZM180.2 52.3C180.2 61.7 186.9 68.4 196 68.4C204.8 68.4 211.5 61.7 211.5 52.3C211.5 42.9 204.8 36.2 196 36.2C186.9 36.2 180.2 42.9 180.2 52.3Z" fill="white"/> <path d="M252.3 74.5H243.1L224.3 30.1H232.8L247.7 66.9L262.6 30.1H270.8L252.3 74.5Z" fill="white"/> <path d="M318.8 52V55H283.8C284.7 64.1 291.1 68.7 298.7 68.7C303.8 68.8 308.8 66.9 312.7 63.5L316.7 68.7C311.2 73.9 305.1 75.5 298.4 75.5C285 75.5 275.6 66.4 275.6 52.4C275.6 38.7 285 29 297.8 29C310 28.9 318.8 38.6 318.8 52ZM283.9 48.6H311.3C310.4 41 305.2 35.8 297.9 35.8C290 35.9 285.1 41 283.9 48.6Z" fill="white"/> <path d="M376 52.3C376 65.4 366 75.4 352.6 75.4C338.9 75.4 328.9 65.4 328.9 52.3C328.9 38.9 338.9 28.9 352.6 28.9C365.9 28.9 376 38.9 376 52.3ZM336.8 52.3C336.8 61.7 343.5 68.4 352.6 68.4C361.4 68.4 368.1 61.7 368.1 52.3C368.1 42.9 361.4 36.2 352.6 36.2C343.4 36.2 336.8 42.9 336.8 52.3Z" fill="white"/> <path d="M88.1 14.9C79.5 6.4 68.3 1.2 56.2 0C55.3 0 54.6 0.8 54.6 1.8C54.6 2.2 54.7 2.5 55 2.8L73.8 21.3C73.8 21.6 73.8 21.6 73.5 21.6C68.3 17.8 62.2 15.5 55.9 14.9C55.3 14.8 54.8 15.2 54.7 15.8C54.7 16.1 54.8 16.4 55 16.7L67.8 29.5C67.8 29.5 67.8 29.8 67.5 29.5C64 27.3 60.1 25.9 55.9 25.5C55.3 25.5 55 26.1 55.3 26.7L76.9 48.3C77.5 48.9 78.4 48.3 78.1 47.7C77.8 43.6 76.4 39.6 74.1 36.1C73.8 36.1 74.1 35.8 74.1 36.1L86.6 48.3C87.2 48.9 88.4 48.3 88.4 47.4C87.7 41 85.4 34.8 81.7 29.5C81.4 29.5 81.7 29.2 81.7 29.5L100.6 48C101.1 48.6 101.9 48.7 102.5 48.3C103 48 103.2 47.4 103 46.8C101.9 34.7 96.6 23.4 88.1 14.9Z" fill="#00ADFF"/> <path d="M14.9 14.9C23.6 6.5 34.8 1.2 46.8 0C47.7 0 48.4 0.6 48.5 1.5C48.5 1.9 48.4 2.4 48 2.7L29.5 21.3C29.2 21.6 29.5 21.6 29.5 21.6C34.8 17.8 41 15.5 47.4 14.9C48.3 14.9 48.9 16.1 48.3 16.7L35.6 29.5C35.3 29.5 35.6 29.8 35.6 29.5C39.1 27.3 43 26 47.2 25.5C47.8 25.5 48.4 26.1 47.8 26.7L26.1 48.3C25.5 48.9 24.9 48.3 24.9 47.7C25.3 43.6 26.8 39.6 29.2 36.1C29.2 36.1 28.9 35.8 28.9 36.1L16.7 48.3C15.8 48.9 14.6 48.3 14.9 47.4C15.5 40.9 17.8 34.7 21.6 29.5C21.6 29.5 21.3 29.2 21.3 29.5L2.7 48C1.5 49.2 0 48.3 0 46.8C1.2 34.8 6.5 23.6 14.9 14.9Z" fill="#F05245"/> <path d="M14.9 88.8C23.4 97.4 34.7 102.7 46.8 103.7C47.6 103.8 48.3 103.3 48.4 102.5C48.5 102 48.3 101.6 48 101.2L29.5 82.4C29.2 82.4 29.5 82.1 29.5 82.4C34.8 86.2 41 88.5 47.4 89C48.3 89 48.9 87.8 48.3 87.2L35.6 74.5C35.3 74.2 35.6 74.2 35.6 74.2C39 76.5 43 78 47.1 78.4C47.7 78.4 48.3 77.5 47.7 77.2L26.1 55.6C25.5 55 24.9 55.3 24.9 56.2C25.3 60.3 26.8 64.3 29.2 67.8C29.2 67.8 28.9 68.1 28.9 67.8L16.7 55.6C15.8 55 14.6 55.3 14.9 56.5C15.5 62.9 17.8 69 21.6 74.1C21.6 74.3 21.5 74.4 21.3 74.4L2.7 55.6C2 55 0.9 55.2 0.4 55.9C0.2 56.2 0.1 56.5 0 56.9C1.1 68.9 6.4 80.2 14.9 88.8Z" fill="#1CEBCF"/> <path d="M88.1 88.8C79.6 97.5 68.3 102.8 56.2 103.7C55 104 54.1 102.2 55 101.3L73.8 82.5C73.8 82.5 73.8 82.2 73.5 82.5C68.3 86.3 62.2 88.6 55.9 89.2C55.3 89.3 54.8 88.8 54.7 88.2C54.7 87.9 54.8 87.6 55 87.3L67.8 74.5C67.8 74.2 67.8 74.2 67.5 74.2C64.1 76.6 60.1 78.1 56 78.4C55.5 78.3 55.2 77.9 55.3 77.5C55.3 77.4 55.3 77.3 55.4 77.2L77 55.6C77.6 55 78.5 55.3 78.2 56.2C77.9 60.3 76.5 64.3 74.2 67.8C73.9 67.8 74.2 68.1 74.2 67.8L86.7 55.6C87.1 55.2 87.8 55.2 88.2 55.6C88.4 55.8 88.5 56.2 88.5 56.5C87.8 62.8 85.5 68.9 81.8 74.1C81.5 74.4 81.8 74.4 81.8 74.4L100.6 55.6C101.5 54.7 103.3 55.6 103 56.8C102 68.9 96.7 80.2 88.1 88.8Z" fill="#FFE300"/> <path opacity="0.87" d="M390.8 31.9V43H388.9V31.9H385.4V30.1H394.4V31.9H390.8Z" fill="white"/> <path opacity="0.87" d="M407.7 43V34.4L404.7 40.5999H403.3L400.3 34.4V43H398.3V30.2H400.3L404 38.2L407.7 30.2H409.6V43H407.7Z" fill="white"/> </g> <defs> <clipPath id="clip0"> <rect width="409" height="104" fill="white"/> </clipPath> </defs> </svg> </div> </a> <a class="logo-text" href="https://docs.coveo.com"> <span class="logo-text-bar">|</span> <span class="logo-text-custom">docs</span> </a> </div> <div class="search"> <div id="coveoConnectHeaderStandaloneSearchbox" class="searchbox"> <div class="CoveoSearchbox" style="display: flex;" type="text" data-auto-focus="false" data-enable-omnibox="true" data-inline="false" data-enable-wildcards="true" data-enable-search-as-you-type="false" data-enable-reveal-query-suggest-addon="true" data-enable-query-syntax="true" data-enable-field-addon="true" data-placeholder="Search"></div> <div class="CoveoAnalytics"></div> </div> </div> <nav class="subnav"> <ul> <li><a href="https://connect.coveo.com/" target="_blank">Community</a></li> <li><a href="https://docs.google.com/forms/d/e/1FAIpQLSeyNL18g4JWIDR5xEyIMY48JIjyjwXRmlCveecjXBNSLh4Ygg/viewform?usp=sf_link" target="_blank">Feedback</a></li> <li><a href="https://docs.coveo.com/en/3378/">News</a></li> </ul> </nav> </div> </div> </header> <subHeader class="no-sticky"> <div class="content"> <nav class="navBar"> <ul> <li><button class="dropdownButton">Guides<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://docs.coveo.com/en/1724/">Searching With Coveo</a></li> <li><a href="https://docs.coveo.com/en/2648/">Project Guide</a></li> <li><a href="https://docs.coveo.com/en/1351/">Services</a></li> </li> </ul> </button> </li> <li> <button class="dropdownButton">API Reference<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://coveo.github.io/search-ui/" target="_blank">JavaScript Search Framework</a></li>  <li><a href="https://docs.coveo.com/en/headless/latest/reference/">Headless</a></li> <li><a href="https://docs.coveo.com/en/12/">Push API</a></li> <li><a href="https://docs.coveo.com/en/8/">Field API</a></li> <li><a href="https://docs.coveo.com/en/13/">Search API</a></li> <li><a href="https://docs.coveo.com/en/18/">Usage Analytics API</a></li> <li><a href="https://docs.coveo.com/en/4/">Other APIs</a></li> </ul> </button> </li> <li> <button class="dropdownButton">Extensions<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://docs.coveo.com/en/1499/">Coveo for Commerce</a></li> <li><a href="https://docs.coveo.com/en/1243/">Coveo for Salesforce</a></li> <li><a href="https://docs.coveo.com/en/1479/">Coveo for ServiceNow</a></li> <li><a href="https://docs.coveo.com/en/2709/">Coveo for Sitecore</a></li> </ul> </button> </li> </ul> </nav> </div> </subHeader> <div class="container container-main"> <div class="row"> <div id="toc-column" class="col-1 col-menu menu-sticky-wrap menu-highlight"> <div id="filter-box-container"> <div id="filter-box-header">Filter</div> <div id="filter-box-body"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <div class="ctr-box-filter"> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited" title="Display inherited methods and properties"> Inherited</label><br> </div> </div> </div> </div> </div> </div> <div id="filter-box-footer"></div> </div> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <a id="globals-toc-link" href=../globals.html><b>Globals</b></a> </ul> <ul class="current"> <li class="current tsd-kind-interface"> <a href="ifieldoption.html" class="tsd-kind-icon">IField<wbr>Option</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#charat" class="tsd-kind-icon">char<wbr>At</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#charcodeat" class="tsd-kind-icon">char<wbr>Code<wbr>At</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#concat" class="tsd-kind-icon">concat</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#indexof" class="tsd-kind-icon">index<wbr>Of</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#lastindexof" class="tsd-kind-icon">last<wbr>Index<wbr>Of</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"> <a href="ifieldoption.html#localecompare" class="tsd-kind-icon">locale<wbr>Compare</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#match" class="tsd-kind-icon">match</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#replace" class="tsd-kind-icon">replace</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#search" class="tsd-kind-icon">search</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#slice" class="tsd-kind-icon">slice</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#split" class="tsd-kind-icon">split</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#substr" class="tsd-kind-icon">substr</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#substring" class="tsd-kind-icon">substring</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#tolocalelowercase" class="tsd-kind-icon">to<wbr>Locale<wbr>Lower<wbr>Case</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#tolocaleuppercase" class="tsd-kind-icon">to<wbr>Locale<wbr>Upper<wbr>Case</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#tolowercase" class="tsd-kind-icon">to<wbr>Lower<wbr>Case</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#tostring" class="tsd-kind-icon">to<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#touppercase" class="tsd-kind-icon">to<wbr>Upper<wbr>Case</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#trim" class="tsd-kind-icon">trim</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#trimleft" class="tsd-kind-icon">trim<wbr>Left</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#trimright" class="tsd-kind-icon">trim<wbr>Right</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#valueof" class="tsd-kind-icon">value<wbr>Of</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="ifieldoption.html#string" class="tsd-kind-icon">String</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="ifieldoption.html#length" class="tsd-kind-icon">length</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> <div id="separator"></div> <div class="col-2 col-content"> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <a id="home-menu-link" class="aui-nav-link" title="Go to the home page" href=..> <i class="fa fa-home" aria-hidden="true"></i> </a> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="ifieldoption.html">IFieldOption</a> </li> </ul> <h1>Interface IFieldOption</h1> </div> </div> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The <code>IFieldOption</code> interface declares a type for options that should contain a field to be used in a query.</p> </div> <p>The only constraint this type has over a basic string is that it should start with the <code>@</code> character.</p> </div> </section> <div class="preview-container tsd-panel"> <div class="overlay"></div> </div> <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-inherited"> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#charat" class="tsd-kind-icon">char<wbr>At</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#charcodeat" class="tsd-kind-icon">char<wbr>Code<wbr>At</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#concat" class="tsd-kind-icon">concat</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#indexof" class="tsd-kind-icon">index<wbr>Of</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#lastindexof" class="tsd-kind-icon">last<wbr>Index<wbr>Of</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"><a href="ifieldoption.html#localecompare" class="tsd-kind-icon">locale<wbr>Compare</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#match" class="tsd-kind-icon">match</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#replace" class="tsd-kind-icon">replace</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#search" class="tsd-kind-icon">search</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#slice" class="tsd-kind-icon">slice</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#split" class="tsd-kind-icon">split</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#substr" class="tsd-kind-icon">substr</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#substring" class="tsd-kind-icon">substring</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#tolocalelowercase" class="tsd-kind-icon">to<wbr>Locale<wbr>Lower<wbr>Case</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#tolocaleuppercase" class="tsd-kind-icon">to<wbr>Locale<wbr>Upper<wbr>Case</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#tolowercase" class="tsd-kind-icon">to<wbr>Lower<wbr>Case</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#touppercase" class="tsd-kind-icon">to<wbr>Upper<wbr>Case</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#trim" class="tsd-kind-icon">trim</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#trimleft" class="tsd-kind-icon">trim<wbr>Left</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#trimright" class="tsd-kind-icon">trim<wbr>Right</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#valueof" class="tsd-kind-icon">value<wbr>Of</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ifieldoption.html#string" class="tsd-kind-icon">String</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ifieldoption.html#length" class="tsd-kind-icon">length</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-inherited"> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="charat" class="tsd-anchor"></a> <h3>char<wbr>At</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">char<wbr>At<span class="tsd-signature-symbol">(</span>pos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.charAt</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:322</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the character at the specified index.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>pos: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The zero-based index of the desired character.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="charcodeat" class="tsd-anchor"></a> <h3>char<wbr>Code<wbr>At</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">char<wbr>Code<wbr>At<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.charCodeAt</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:328</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the Unicode value of the character at the specified location.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>index: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="concat" class="tsd-anchor"></a> <h3>concat</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">concat<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>strings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.concat</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:334</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns a string that contains the concatenation of two or more strings.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>strings: <span class="tsd-signature-type">string[]</span></h5> <div class="tsd-comment tsd-typography"> <p>The strings to append to the end of the string.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="indexof" class="tsd-anchor"></a> <h3>index<wbr>Of</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">index<wbr>Of<span class="tsd-signature-symbol">(</span>searchString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, position<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.indexOf</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:341</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the position of the first occurrence of a substring.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>searchString: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The substring to search for in the string</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> position: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="lastindexof" class="tsd-anchor"></a> <h3>last<wbr>Index<wbr>Of</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">last<wbr>Index<wbr>Of<span class="tsd-signature-symbol">(</span>searchString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, position<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.lastIndexOf</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:348</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the last occurrence of a substring in the string.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>searchString: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The substring to search for.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> position: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The index at which to begin searching. If omitted, the search begins at the end of the string.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"> <a name="localecompare" class="tsd-anchor"></a> <h3>locale<wbr>Compare</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">locale<wbr>Compare<span class="tsd-signature-symbol">(</span>that<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.localeCompare</p> <p>Overwrites String.localeCompare</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:354</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Determines whether two strings are equivalent in the current locale.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>that: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>String to compare to target string</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="match" class="tsd-anchor"></a> <h3>match</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">(</span>regexp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RegExpMatchArray</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.match</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:360</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Matches a string with a regular expression, and returns an array containing the results of that search.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>regexp: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></h5> <div class="tsd-comment tsd-typography"> <p>A variable name or string literal containing the regular expression pattern and flags.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RegExpMatchArray</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">null</span> </h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="replace" class="tsd-anchor"></a> <h3>replace</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">replace<span class="tsd-signature-symbol">(</span>searchValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span>, replaceValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> <li class="tsd-signature tsd-kind-icon">replace<span class="tsd-signature-symbol">(</span>searchValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span>, replacer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.replace</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:367</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Replaces text in a string, using a regular expression or search string.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>searchValue: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></h5> <div class="tsd-comment tsd-typography"> <p>A string to search for.</p> </div> </li> <li> <h5>replaceValue: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A string containing the text to replace for every successful match of searchValue in this string.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.replace</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:374</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Replaces text in a string, using a regular expression or search string.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>searchValue: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></h5> <div class="tsd-comment tsd-typography"> <p>A string to search for.</p> </div> </li> <li> <h5>replacer: <span class="tsd-signature-type">function</span></h5> <div class="tsd-comment tsd-typography"> <p>A function that returns the replacement text.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>substring<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>substring: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="search" class="tsd-anchor"></a> <h3>search</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">search<span class="tsd-signature-symbol">(</span>regexp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.search</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:380</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Finds the first substring match in a regular expression search.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>regexp: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></h5> <div class="tsd-comment tsd-typography"> <p>The regular expression pattern and applicable flags.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="slice" class="tsd-anchor"></a> <h3>slice</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">slice<span class="tsd-signature-symbol">(</span>start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.slice</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:388</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns a section of a string.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> start: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The index to the beginning of the specified portion of stringObj.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="split" class="tsd-anchor"></a> <h3>split</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">split<span class="tsd-signature-symbol">(</span>separator<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.split</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:395</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Split a string into substrings using the specified separator and return them as an array.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>separator: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></h5> <div class="tsd-comment tsd-typography"> <p>A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>A value used to limit the number of elements returned in the array.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="substr" class="tsd-anchor"></a> <h3>substr</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">substr<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, length<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.substr</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:429</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets a substring beginning at the specified location and having the specified length.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>from: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The starting position of the desired substring. The index of the first character in the string is zero.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> length: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The number of characters to include in the returned substring.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="substring" class="tsd-anchor"></a> <h3>substring</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">substring<span class="tsd-signature-symbol">(</span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from String.substring</p> <ul> <li>Defined in <a href="../../../../../../media/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts">/home/runner/work/search-ui/search-ui/node_modules/typedoc/node_modules/typescript/lib/lib.d.ts:403</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the substring at the specified location within a String object.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>start: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The zero-based index number indicating the beginning of the substring.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end.