Generate doc and run lint

aws · Mar 5, 2022 · e67ada2 · e67ada2
1 parent 06b5bd8
commit e67ada2
Show file tree

Hide file tree

Showing 7 changed files with 2,324 additions and 3,259 deletions.
diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json
diff --git a/docs/classes/defaultclientmetricreport.html b/docs/classes/defaultclientmetricreport.html
diff --git a/docs/classes/monitortask.html b/docs/classes/monitortask.html
@@ -219,7 +219,7 @@ <h3>connection<wbr>Health<wbr>Did<wbr>Change</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/audiovideoobserver.html">AudioVideoObserver</a>.<a href="../interfaces/audiovideoobserver.html#connectionhealthdidchange">connectionHealthDidChange</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/task/MonitorTask.ts#L298">src/task/MonitorTask.ts:298</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/task/MonitorTask.ts#L297">src/task/MonitorTask.ts:297</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -261,7 +261,7 @@ <h3>handle<wbr>Signaling<wbr>Client<wbr>Event</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/signalingclientobserver.html">SignalingClientObserver</a>.<a href="../interfaces/signalingclientobserver.html#handlesignalingclientevent">handleSignalingClientEvent</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/task/MonitorTask.ts#L372">src/task/MonitorTask.ts:372</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/task/MonitorTask.ts#L371">src/task/MonitorTask.ts:371</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -309,7 +309,7 @@ <h3>metrics<wbr>Did<wbr>Receive</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/audiovideoobserver.html">AudioVideoObserver</a>.<a href="../interfaces/audiovideoobserver.html#metricsdidreceive">metricsDidReceive</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/task/MonitorTask.ts#L220">src/task/MonitorTask.ts:220</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/task/MonitorTask.ts#L219">src/task/MonitorTask.ts:219</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>

diff --git a/docs/classes/videoadaptiveprobepolicy.html b/docs/classes/videoadaptiveprobepolicy.html
@@ -261,7 +261,7 @@ <h3>add<wbr>Observer</h3>
 								<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#addobserver">addObserver</a></p>
 								<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#addobserver">addObserver</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L243">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:243</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L241">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:241</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -309,7 +309,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> calculate<wbr>Optim
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#calculateoptimalreceiveset">calculateOptimalReceiveSet</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L387">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:387</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L385">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:385</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -327,7 +327,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> calculate<wbr>Optim
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#calculateoptimalreceivestreams">calculateOptimalReceiveStreams</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L261">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:261</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L259">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:259</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -377,7 +377,7 @@ <h3>choose<wbr>Subscriptions</h3>
 								<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#choosesubscriptions">chooseSubscriptions</a></p>
 								<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#choosesubscriptions">chooseSubscriptions</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L234">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:234</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L232">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:232</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <a href="../interfaces/videostreamidset.html" class="tsd-signature-type">VideoStreamIdSet</a></h4>
@@ -395,7 +395,7 @@ <h3>for<wbr>Each<wbr>Observer</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#foreachobserver">forEachObserver</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L251">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:251</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L249">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:249</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -438,7 +438,7 @@ <h3>remove<wbr>Observer</h3>
 								<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#removeobserver">removeObserver</a></p>
 								<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#removeobserver">removeObserver</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L247">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:247</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L245">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:245</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -481,7 +481,7 @@ <h3>set<wbr>Video<wbr>Priority<wbr>Based<wbr>Policy<wbr>Configs</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#setvideoprioritybasedpolicyconfigs">setVideoPriorityBasedPolicyConfigs</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L257">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:257</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L255">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:255</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -555,7 +555,7 @@ <h3>wants<wbr>Resubscribe</h3>
 								<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#wantsresubscribe">wantsResubscribe</a></p>
 								<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#wantsresubscribe">wantsResubscribe</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L229">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:229</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L227">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:227</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>

diff --git a/docs/classes/videoprioritybasedpolicy.html b/docs/classes/videoprioritybasedpolicy.html
@@ -254,7 +254,7 @@ <h3>add<wbr>Observer</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#addobserver">addObserver</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L243">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:243</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L241">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:241</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -300,7 +300,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> calculate<wbr>Optim
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L387">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:387</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L385">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:385</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -317,7 +317,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> calculate<wbr>Optim
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L261">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:261</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L259">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:259</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -358,7 +358,7 @@ <h3>choose<wbr>Subscriptions</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#choosesubscriptions">chooseSubscriptions</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L234">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:234</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L232">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:232</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <a href="../interfaces/videostreamidset.html" class="tsd-signature-type">VideoStreamIdSet</a></h4>
@@ -375,7 +375,7 @@ <h3>for<wbr>Each<wbr>Observer</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L251">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:251</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L249">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:249</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -417,7 +417,7 @@ <h3>remove<wbr>Observer</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#removeobserver">removeObserver</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L247">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:247</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L245">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:245</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -458,7 +458,7 @@ <h3>set<wbr>Video<wbr>Priority<wbr>Based<wbr>Policy<wbr>Configs</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L257">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:257</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L255">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:255</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -529,7 +529,7 @@ <h3>wants<wbr>Resubscribe</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#wantsresubscribe">wantsResubscribe</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L229">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:229</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L227">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:227</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>

diff --git a/src/clientmetricreport/DefaultClientMetricReport.ts b/src/clientmetricreport/DefaultClientMetricReport.ts
@@ -49,7 +49,7 @@ export default class DefaultClientMetricReport implements ClientMetricReport {
     if (decoderAbnormal <= 0) {
       return 0;
     }
-    return (concealedSamples / totalSamplesReceived * 100);
+    return (concealedSamples / totalSamplesReceived) * 100;
   };
 
   packetLossPercent = (sourceMetricName?: string, ssrc?: number): number => {
@@ -143,7 +143,10 @@ export default class DefaultClientMetricReport implements ClientMetricReport {
       transform: this.identityValue,
       type: SdkMetric.Type.VIDEO_TARGET_ENCODER_BITRATE,
     },
-    totalPacketSendDelay: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_BUCKET_DELAY_MS },
+    totalPacketSendDelay: {
+      transform: this.identityValue,
+      type: SdkMetric.Type.VIDEO_BUCKET_DELAY_MS,
+    },
     roundTripTime: { transform: this.identityValue, type: SdkMetric.Type.STUN_RTT_MS },
     packetsDiscardedOnSend: {
       transform: this.countPerSecond,

diff --git a/src/task/MonitorTask.ts b/src/task/MonitorTask.ts
@@ -354,7 +354,7 @@ export default class MonitorTask
 
     if (
       this.currentVideoDownlinkBandwidthEstimationKbps *
-      MonitorTask.DEFAULT_DOWNLINK_CALLRATE_OVERSHOOT_FACTOR <
+        MonitorTask.DEFAULT_DOWNLINK_CALLRATE_OVERSHOOT_FACTOR <
       requiredBandwidthKbps
     ) {
       this.logger.info(
@@ -407,8 +407,8 @@ export default class MonitorTask
         ? AudioLogEvent.RedmicStartLoss
         : null
       : isPrevSignalBad
-        ? AudioLogEvent.RedmicEndLoss
-        : null;
+      ? AudioLogEvent.RedmicEndLoss
+      : null;
 
     if (signalStrengthEventType) {
       this.context.statsCollector.logAudioEvent(signalStrengthEventType);