UNPKG

@atsu/formidable-client

Version:

A client for Formidable servers written in TypeScript

201 lines 7.22 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>core/client | @tsukugi/formidable-client</title> <meta name="description" content="Documentation for @tsukugi/formidable-client"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@tsukugi/formidable-client</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">@tsukugi/formidable-client</a> </li> <li> <a href="core_client.html">core/client</a> </li> </ul> <h1>Module core/client</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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 "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/core_client.formidableapi.html" class="tsd-kind-icon">FormidableAPI</a></li> </ul> </section> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="../modules.html">Exports</a> </li> <li class=" tsd-kind-module"> <a href="core_api_barrage.html">core/api/barrage</a> </li> <li class=" tsd-kind-module"> <a href="core_api_chapter.html">core/api/chapter</a> </li> <li class=" tsd-kind-module"> <a href="core_api_equipment.html">core/api/equipment</a> </li> <li class=" tsd-kind-module"> <a href="core_api_ship.html">core/api/ship</a> </li> <li class=" tsd-kind-module"> <a href="core_api_voiceline.html">core/api/voiceline</a> </li> <li class="current tsd-kind-module"> <a href="core_client.html">core/client</a> </li> <li class=" tsd-kind-module"> <a href="core_client_client.html">core/client/client</a> </li> <li class=" tsd-kind-module"> <a href="core_database.html">core/database</a> </li> <li class=" tsd-kind-module"> <a href="core_state.html">core/state</a> </li> <li class=" tsd-kind-module"> <a href="core_state_cacheapi.html">core/state/cache<wbr>Api</a> </li> <li class=" tsd-kind-module"> <a href="core_utils.html">core/utils</a> </li> <li class=" tsd-kind-module"> <a href="index.html">index</a> </li> <li class=" tsd-kind-module"> <a href="types_barrages.html">types/barrages</a> </li> <li class=" tsd-kind-module"> <a href="types_chapters.html">types/chapters</a> </li> <li class=" tsd-kind-module"> <a href="types_client.html">types/client</a> </li> <li class=" tsd-kind-module"> <a href="types_equipment_category.html">types/equipment/category</a> </li> <li class=" tsd-kind-module"> <a href="types_equipment_nationality.html">types/equipment/nationality</a> </li> <li class=" tsd-kind-module"> <a href="types_equipment_search.html">types/equipment/search</a> </li> <li class=" tsd-kind-module"> <a href="types_ships_class.html">types/ships/class</a> </li> <li class=" tsd-kind-module"> <a href="types_ships_hull.html">types/ships/hull</a> </li> <li class=" tsd-kind-module"> <a href="types_ships_ship.html">types/ships/ship</a> </li> <li class=" tsd-kind-module"> <a href="types_status.html">types/status</a> </li> <li class=" tsd-kind-module"> <a href="types_version.html">types/version</a> </li> <li class=" tsd-kind-module"> <a href="types_voicelines.html">types/voicelines</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/core_client.formidableapi.html" class="tsd-kind-icon">FormidableAPI</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>