Release 1.0.1

NTTB · Mar 13, 2021 · 614e74b · 614e74b
1 parent 6fe8581
commit 614e74b
Show file tree

Hide file tree

Showing 15 changed files with 93 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -100,3 +100,15 @@ ranking.ranked.forEach((rank, i) => {
   console.log(`${pos}. ${rank.player.name}`)
 })
 ```
+
+
+## Versions
+
+### 1.0.0 - Initial release
+
+- This is the initial release
+
+### 1.0.1 - Correct the ranked/unranked players
+
+- fixed: Before a player would be unranked when a player only has walkovers. Now that player will be ranked first.
+- new: Ranked sets are also included in the result. This is often needed when determing the total win/lose ratio in the ranking.
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/ttmatch.html b/docs/classes/ttmatch.html
@@ -159,7 +159,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
 					<div class="tsd-signature tsd-kind-icon">players<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</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/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L38">tt-match.ts:38</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L38">tt-match.ts:38</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -169,7 +169,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
 					<div class="tsd-signature tsd-kind-icon">sets<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ttmatchset.html" class="tsd-signature-type" data-tsd-kind="Interface">TTMatchSet</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/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L39">tt-match.ts:39</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L39">tt-match.ts:39</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -186,7 +186,7 @@ <h3>add<wbr>Player</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L46">tt-match.ts:46</a></li>
+									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L46">tt-match.ts:46</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -218,7 +218,7 @@ <h3>add<wbr>Set</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L88">tt-match.ts:88</a></li>
+									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L88">tt-match.ts:88</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -262,7 +262,7 @@ <h3>get<wbr>Player<wbr>ById</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L70">tt-match.ts:70</a></li>
+									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L70">tt-match.ts:70</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -293,7 +293,7 @@ <h3>get<wbr>Players</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L57">tt-match.ts:57</a></li>
+									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L57">tt-match.ts:57</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -315,7 +315,7 @@ <h3>get<wbr>Set<wbr>ById</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L110">tt-match.ts:110</a></li>
+									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L110">tt-match.ts:110</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -346,7 +346,7 @@ <h3>get<wbr>Sets</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L77">tt-match.ts:77</a></li>
+									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L77">tt-match.ts:77</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -368,7 +368,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Player<wbr>IdKno
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L114">tt-match.ts:114</a></li>
+									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L114">tt-match.ts:114</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -391,7 +391,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Set<wbr>Known</h
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L118">tt-match.ts:118</a></li>
+									<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L118">tt-match.ts:118</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>

diff --git a/docs/index.html b/docs/index.html
@@ -157,6 +157,22 @@ <h2>Example</h2>
 <span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`</span><span style="color: #0000FF">${</span><span style="color: #001080">pos</span><span style="color: #0000FF">}</span><span style="color: #A31515">. </span><span style="color: #0000FF">${</span><span style="color: #001080">rank</span><span style="color: #000000FF">.</span><span style="color: #001080">player</span><span style="color: #000000FF">.</span><span style="color: #001080">name</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">)</span>
 <span style="color: #000000">})</span>
 </code></pre>
+				<a href="#versions" id="versions" style="color: inherit; text-decoration: none;">
+					<h2>Versions</h2>
+				</a>
+				<a href="#100---initial-release" id="100---initial-release" style="color: inherit; text-decoration: none;">
+					<h3>1.0.0 - Initial release</h3>
+				</a>
+				<ul>
+					<li>This is the initial release</li>
+				</ul>
+				<a href="#101---correct-the-rankedunranked-players" id="101---correct-the-rankedunranked-players" style="color: inherit; text-decoration: none;">
+					<h3>1.0.1 - Correct the ranked/unranked players</h3>
+				</a>
+				<ul>
+					<li>fixed: Before a player would be unranked when a player only has walkovers. Now that player will be ranked first.</li>
+					<li>new: Ranked sets are also included in the result. This is often needed when determing the total win/lose ratio in the ranking.</li>
+				</ul>
 			</div>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">

diff --git a/docs/interfaces/ttgame.html b/docs/interfaces/ttgame.html
@@ -102,7 +102,7 @@ <h3>away<wbr>Score</h3>
 					<div class="tsd-signature tsd-kind-icon">away<wbr>Score<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-game.ts#L13">tt-game.ts:13</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-game.ts#L13">tt-game.ts:13</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -117,7 +117,7 @@ <h3>home<wbr>Score</h3>
 					<div class="tsd-signature tsd-kind-icon">home<wbr>Score<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-game.ts#L8">tt-game.ts:8</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-game.ts#L8">tt-game.ts:8</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/ttgamerules.html b/docs/interfaces/ttgamerules.html
@@ -102,7 +102,7 @@ <h3>score<wbr>Distance</h3>
 					<div class="tsd-signature tsd-kind-icon">score<wbr>Distance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/rules/tt-game-rules.ts#L13">rules/tt-game-rules.ts:13</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/rules/tt-game-rules.ts#L13">rules/tt-game-rules.ts:13</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -117,7 +117,7 @@ <h3>score<wbr>Minimum</h3>
 					<div class="tsd-signature tsd-kind-icon">score<wbr>Minimum<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/rules/tt-game-rules.ts#L8">rules/tt-game-rules.ts:8</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/rules/tt-game-rules.ts#L8">rules/tt-game-rules.ts:8</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/ttmatchrank.html b/docs/interfaces/ttmatchrank.html
@@ -101,6 +101,7 @@ <h2>Index</h2>
 							<h3>Properties</h3>
 							<ul class="tsd-index-list">
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ttmatchrank.html#ranked" class="tsd-kind-icon">ranked</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ttmatchrank.html#rankedsets" class="tsd-kind-icon">ranked<wbr>Sets</a></li>
 							</ul>
 						</section>
 					</div>
@@ -114,7 +115,7 @@ <h3>ranked</h3>
 					<div class="tsd-signature tsd-kind-icon">ranked<span class="tsd-signature-symbol">:</span> <a href="ttplayerrank.html" class="tsd-signature-type" data-tsd-kind="Interface">TTPlayerRank</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match-rank.ts#L11">tt-match-rank.ts:11</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match-rank.ts#L11">tt-match-rank.ts:11</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -123,6 +124,22 @@ <h3>ranked</h3>
 						</div>
 					</div>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="rankedsets" class="tsd-anchor"></a>
+					<h3>ranked<wbr>Sets</h3>
+					<div class="tsd-signature tsd-kind-icon">ranked<wbr>Sets<span class="tsd-signature-symbol">:</span> <a href="ttmatchset.html" class="tsd-signature-type" data-tsd-kind="Interface">TTMatchSet</a><span class="tsd-signature-symbol">[]</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match-rank.ts#L17">tt-match-rank.ts:17</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>The sets that are used in the calculating the ranking.
+							Only sets of ranked players are included.</p>
+						</div>
+					</div>
+				</section>
 			</section>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -152,6 +169,9 @@ <h3>ranked</h3>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
 								<a href="ttmatchrank.html#ranked" class="tsd-kind-icon">ranked</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="ttmatchrank.html#rankedsets" class="tsd-kind-icon">ranked<wbr>Sets</a>
+							</li>
 						</ul>
 					</li>
 				</ul>

diff --git a/docs/interfaces/ttmatchrules.html b/docs/interfaces/ttmatchrules.html
@@ -102,7 +102,7 @@ <h3>defeat<wbr>Points</h3>
 					<div class="tsd-signature tsd-kind-icon">defeat<wbr>Points<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/rules/tt-match-rules.ts#L13">rules/tt-match-rules.ts:13</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/rules/tt-match-rules.ts#L13">rules/tt-match-rules.ts:13</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -117,7 +117,7 @@ <h3>victory<wbr>Points</h3>
 					<div class="tsd-signature tsd-kind-icon">victory<wbr>Points<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/rules/tt-match-rules.ts#L8">rules/tt-match-rules.ts:8</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/rules/tt-match-rules.ts#L8">rules/tt-match-rules.ts:8</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/ttmatchset.html b/docs/interfaces/ttmatchset.html
@@ -104,7 +104,7 @@ <h3>away<wbr>Player<wbr>Id</h3>
 					<div class="tsd-signature tsd-kind-icon">away<wbr>Player<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L20">tt-match.ts:20</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L20">tt-match.ts:20</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -119,7 +119,7 @@ <h3>home<wbr>Player<wbr>Id</h3>
 					<div class="tsd-signature tsd-kind-icon">home<wbr>Player<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L15">tt-match.ts:15</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L15">tt-match.ts:15</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -134,7 +134,7 @@ <h3>id</h3>
 					<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L10">tt-match.ts:10</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L10">tt-match.ts:10</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -149,7 +149,7 @@ <h3>set</h3>
 					<div class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">:</span> <a href="ttset.html" class="tsd-signature-type" data-tsd-kind="Interface">TTSet</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/15408e3/src/tt-match.ts#L25">tt-match.ts:25</a></li>
+							<li>Defined in <a href="https://github.com/NTTB/tt-match-ranking/blob/6fe8581/src/tt-match.ts#L25">tt-match.ts:25</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">