From 5360bdc8ece5c973815d8c42a4bcb6f3620bccc9 Mon Sep 17 00:00:00 2001 From: Chi Vinh Le Date: Tue, 21 Nov 2017 12:42:17 +0100 Subject: [PATCH] Add some docs --- .../src/tabs/configure/components/AssetStatusInfo.js | 2 ++ client/coral-framework/hocs/withMergedSettings.js | 9 +++++++++ 2 files changed, 11 insertions(+) diff --git a/client/coral-embed-stream/src/tabs/configure/components/AssetStatusInfo.js b/client/coral-embed-stream/src/tabs/configure/components/AssetStatusInfo.js index 2a1900533..d3c2f14d7 100644 --- a/client/coral-embed-stream/src/tabs/configure/components/AssetStatusInfo.js +++ b/client/coral-embed-stream/src/tabs/configure/components/AssetStatusInfo.js @@ -18,11 +18,13 @@ class AssetStatusInfo extends React.Component { this.setupTimer(nextProps); } + // Rerendering interval. If remaining time > 1min, rerender every minute, otherwise evey second. interval(closedAt) { const diff = new Date(closedAt).getTime() - new Date().getTime(); return diff > 60000 ? 60000 : 1000; } + // Timer that counts down the remaining time. setupTimer({closedAt, isClosed} = this.props) { if (this.timer && (isClosed || !closedAt)) { clearTimeout(this.timer); diff --git a/client/coral-framework/hocs/withMergedSettings.js b/client/coral-framework/hocs/withMergedSettings.js index 8368475e6..c90e360bc 100644 --- a/client/coral-framework/hocs/withMergedSettings.js +++ b/client/coral-framework/hocs/withMergedSettings.js @@ -3,6 +3,15 @@ import assignWith from 'lodash/assignWith'; import get from 'lodash/get'; import {withPropsOnChange} from 'recompose'; +/** + * Exports a HOC that applies props at `pending` to + * props at `settings` and writes into `result` prop name. + * `Settings`, and `pending` can have a dotnotation like + * "asset.settings". + * + * Example: + * withMergedSettings('asset.settings', 'pending', 'mergedSettings') + */ const withMergedSettings = (settings, pending, result) => withPropsOnChange( (props, nextProps) =>