@atsu/formidable-client

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>FormidableAPI | @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="../modules/core_client.html">core/client</a> </li> <li> <a href="core_client.formidableapi.html">FormidableAPI</a> </li> </ul> <h1>Class FormidableAPI</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">FormidableAPI</span> </li> </ul> </section> <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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="core_client.formidableapi.html#constructor" class="tsd-kind-icon">constructor</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-class"><a href="core_client.formidableapi.html#api" class="tsd-kind-icon">api</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="core_client.formidableapi.html#barrages" class="tsd-kind-icon">barrages</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="core_client.formidableapi.html#chapters" class="tsd-kind-icon">chapters</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="core_client.formidableapi.html#equipments" class="tsd-kind-icon">equipments</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="core_client.formidableapi.html#options" class="tsd-kind-icon">options</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="core_client.formidableapi.html#ships" class="tsd-kind-icon">ships</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="core_client.formidableapi.html#state" class="tsd-kind-icon">state</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="core_client.formidableapi.html#tools" class="tsd-kind-icon">tools</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="core_client.formidableapi.html#voicelines" class="tsd-kind-icon">voicelines</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>FormidableAPI<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/core_client_client.formidableclientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FormidableClientOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="core_client.formidableapi.html" class="tsd-signature-type" data-tsd-kind="Class">FormidableAPI</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L19">src/core/client/index.ts:19</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/core_client_client.formidableclientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FormidableClientOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="core_client.formidableapi.html" class="tsd-signature-type" data-tsd-kind="Class">FormidableAPI</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="api" class="tsd-anchor"></a> <h3>api</h3> <div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <a href="../interfaces/core_client_client.formidablecoreapi.html" class="tsd-signature-type" data-tsd-kind="Interface">FormidableCoreAPI</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L17">src/core/client/index.ts:17</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="barrages" class="tsd-anchor"></a> <h3>barrages</h3> <div class="tsd-signature tsd-kind-icon">barrages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_barrages.barrage.html" class="tsd-signature-type" data-tsd-kind="Interface">Barrage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L16">src/core/client/index.ts:16</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_barrages.barrage.html" class="tsd-signature-type" data-tsd-kind="Interface">Barrage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_barrages.barrage.html" class="tsd-signature-type" data-tsd-kind="Interface">Barrage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_barrages.barrage.html" class="tsd-signature-type" data-tsd-kind="Interface">Barrage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="chapters" class="tsd-anchor"></a> <h3>chapters</h3> <div class="tsd-signature tsd-kind-icon">chapters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_chapters.chapter.html" class="tsd-signature-type" data-tsd-kind="Interface">Chapter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L14">src/core/client/index.ts:14</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_chapters.chapter.html" class="tsd-signature-type" data-tsd-kind="Interface">Chapter</a><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_chapters.chapter.html" class="tsd-signature-type" data-tsd-kind="Interface">Chapter</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_chapters.chapter.html" class="tsd-signature-type" data-tsd-kind="Interface">Chapter</a><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="equipments" class="tsd-anchor"></a> <h3>equipments</h3> <div class="tsd-signature tsd-kind-icon">equipments<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>category<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>nationality<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L13">src/core/client/index.ts:13</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>category<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>nationality<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_equipment_category.equipment.html" class="tsd-signature-type" data-tsd-kind="Interface">Equipment</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="options" class="tsd-anchor"></a> <h3>options</h3> <div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/core_client_client.formidableclientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FormidableClientOptions</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L11">src/core/client/index.ts:11</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="ships" class="tsd-anchor"></a> <h3>ships</h3> <div class="tsd-signature tsd-kind-icon">ships<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>hull<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>code<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>nationality<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>random<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>rarity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>shipClass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L12">src/core/client/index.ts:12</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>hull<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>code<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>code<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>code: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>nationality<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>random<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>rarity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>ship<wbr>Class<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>name<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types_ships_ship.ship.html" class="tsd-signature-type" data-tsd-kind="Interface">Ship</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="state" class="tsd-anchor"></a> <h3>state</h3> <div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <a href="../interfaces/core_state.formidablestate.html" class="tsd-signature-type" data-tsd-kind="Interface">FormidableState</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L18">src/core/client/index.ts:18</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="tools" class="tsd-anchor"></a> <h3>tools</h3> <div class="tsd-signature tsd-kind-icon">tools<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClientTools</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L19">src/core/client/index.ts:19</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="voicelines" class="tsd-anchor"></a> <h3>voicelines</h3> <div class="tsd-signature tsd-kind-icon">voicelines<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ship<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>id<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types_voicelines.html#voicelines" class="tsd-signature-type" data-tsd-kind="Type alias">Voicelines</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Tsukugi/FormidableClient/blob/ec803cd/src/core/client/index.ts#L15">src/core/client/index.ts:15</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>ship<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>id<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types_voicelines.html#voicelines" class="tsd-signature-type" data-tsd-kind="Type alias">Voicelines</a><span class="tsd-signature-symbol">></span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>id<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types_voicelines.html#voicelines" class="tsd-signature-type" data-tsd-kind="Type alias">Voicelines</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>id: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types_voicelines.html#voicelines" class="tsd-signature-type" data-tsd-kind="Type alias">Voicelines</a><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> </ul> </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="../modules/core_api_barrage.html">core/api/barrage</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_api_chapter.html">core/api/chapter</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_api_equipment.html">core/api/equipment</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_api_ship.html">core/api/ship</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_api_voiceline.html">core/api/voiceline</a> </li> <li class="current tsd-kind-module"> <a href="../modules/core_client.html">core/client</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_client_client.html">core/client/client</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_database.html">core/database</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_state.html">core/state</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_state_cacheapi.html">core/state/cache<wbr>Api</a> </li> <li class=" tsd-kind-module"> <a href="../modules/core_utils.html">core/utils</a> </li> <li class=" tsd-kind-module"> <a href="../modules/index.html">index</a> </li> <li class=" tsd-kind-module"> <a href="../modules/types_barrages.html">types/barrages</a> </li> <li class=" tsd-kind-module"> <a href="../modules/types_chapters.html">types/chapters</a> </li> <li class=" tsd-kind-module"> <a href="../modules/types_client.html">types/client</a> </li> <li class=" tsd-kind-module"> <a href="../modules/types_equipment_category.html">types/equipment/category</a> </li> <li class=" tsd-kind-module"> <a href="../modules/types_equipment_nationality.html">types/equipment/nationality</a> </li> <li class=" tsd-kind-module"> <a href="../modules/types_equipment_search.html">types/equipment/search</a> </li> <li class=" tsd-kind-module"> <a href="../modules/types_ships_class.html">types/ships/class</a> </li> <li class=" tsd-kind-module"> <a href="../m