jiti-meet/react/features/base/redux/functions.ts

153 lines
5.3 KiB
TypeScript
Raw Normal View History

import _ from 'lodash';
2019-03-21 16:38:29 +00:00
import { connect as reduxConnect } from 'react-redux';
2022-07-12 11:41:26 +00:00
import { IStore } from '../../app/types';
2016-12-12 00:29:13 +00:00
/**
* Sets specific properties of a specific state to specific values and prevents
* unnecessary state changes.
*
2022-07-12 11:41:26 +00:00
* @param {T} target - The state on which the specified properties are to
2016-12-12 00:29:13 +00:00
* be set.
2022-07-12 11:41:26 +00:00
* @param {T} source - The map of properties to values which are to be set
2016-12-12 00:29:13 +00:00
* on the specified target.
2022-07-12 11:41:26 +00:00
* @returns {T} The specified target if the values of the specified
2016-12-12 00:29:13 +00:00
* properties equal the specified values; otherwise, a new state constructed
* from the specified target by setting the specified properties to the
* specified values.
*/
2022-07-12 11:41:26 +00:00
export function assign<T extends Object>(target: T, source: T): T {
2016-12-12 00:29:13 +00:00
let t = target;
for (const property in source) { // eslint-disable-line guard-for-in
t = _set(t, property, source[property], t === target);
2016-12-12 00:29:13 +00:00
}
return t;
}
2019-03-21 16:38:29 +00:00
/**
* Wrapper function for the react-redux connect function to avoid having to
* declare function types for flow, but still let flow warn for other errors.
*
2022-07-12 11:41:26 +00:00
* @param {any} mapStateToProps - Redux mapStateToProps function.
2019-03-21 16:38:29 +00:00
* @param {Function?} mapDispatchToProps - Redux mapDispatchToProps function.
* @returns {Connector}
*/
export function connect(
2022-07-12 11:41:26 +00:00
mapStateToProps?: any, mapDispatchToProps?: Function) {
return reduxConnect(mapStateToProps, mapDispatchToProps);
2019-03-21 16:38:29 +00:00
}
/**
* Determines whether {@code a} equals {@code b} according to deep comparison
* (which makes sense for Redux and its state definition).
*
* @param {*} a - The value to compare to {@code b}.
* @param {*} b - The value to compare to {@code a}.
* @returns {boolean} True if {@code a} equals {@code b} (according to deep
* comparison); false, otherwise.
*/
2017-09-01 21:25:48 +00:00
export function equals(a: any, b: any) {
return _.isEqual(a, b);
}
/**
* Sets a specific property of a specific state to a specific value. Prevents
* unnecessary state changes (when the specified {@code value} is equal to the
* value of the specified {@code property} of the specified {@code state}).
*
2022-07-12 11:41:26 +00:00
* @param {T} state - The (Redux) state from which a new state is to be
* constructed by setting the specified {@code property} to the specified
* {@code value}.
* @param {string} property - The property of {@code state} which is to be
* assigned the specified {@code value} (in the new state).
* @param {*} value - The value to assign to the specified {@code property}.
2022-07-12 11:41:26 +00:00
* @returns {T} The specified {@code state} if the value of the specified
* {@code property} equals the specified <tt>value/tt>; otherwise, a new state
* constructed from the specified {@code state} by setting the specified
* {@code property} to the specified {@code value}.
*/
2022-07-12 11:41:26 +00:00
export function set<T extends Object>(state: T, property: keyof T, value: any): T {
return _set(state, property, value, /* copyOnWrite */ true);
2016-12-12 00:29:13 +00:00
}
/* eslint-disable max-params */
/**
* Sets a specific property of a specific state to a specific value. Prevents
* unnecessary state changes (when the specified {@code value} is equal to the
* value of the specified {@code property} of the specified {@code state}).
2016-12-12 00:29:13 +00:00
*
2022-07-12 11:41:26 +00:00
* @param {T} state - The (Redux) state from which a state is to be
* constructed by setting the specified {@code property} to the specified
* {@code value}.
* @param {string} property - The property of {@code state} which is to be
* assigned the specified {@code value}.
* @param {*} value - The value to assign to the specified {@code property}.
* @param {boolean} copyOnWrite - If the specified {@code state} is to not be
* modified, {@code true}; otherwise, {@code false}.
2022-07-12 11:41:26 +00:00
* @returns {T} The specified {@code state} if the value of the specified
* {@code property} equals the specified <tt>value/tt> or {@code copyOnWrite}
2016-12-12 00:29:13 +00:00
* is truthy; otherwise, a new state constructed from the specified
* {@code state} by setting the specified {@code property} to the specified
* {@code value}.
2016-12-12 00:29:13 +00:00
*/
2022-07-12 11:41:26 +00:00
function _set<T extends Object>(
state: T,
property: keyof T,
2017-09-01 21:25:48 +00:00
value: any,
2022-07-12 11:41:26 +00:00
copyOnWrite: boolean): T {
// Delete state properties that are to be set to undefined. (It is a matter
// of personal preference, mostly.)
if (typeof value === 'undefined'
&& Object.prototype.hasOwnProperty.call(state, property)) {
2016-12-12 00:29:13 +00:00
const newState = copyOnWrite ? { ...state } : state;
if (delete newState[property]) {
return newState;
}
}
if (state[property] !== value) {
2016-12-12 00:29:13 +00:00
if (copyOnWrite) {
return {
...state,
[property]: value
};
}
state[property] = value;
}
return state;
}
2016-12-12 00:29:13 +00:00
/* eslint-enable max-params */
2017-09-01 21:25:48 +00:00
/**
* Returns redux state from the specified {@code stateful} which is presumed to
* be related to the redux state (e.g. The redux store, the redux
* {@code getState} function).
2017-09-01 21:25:48 +00:00
*
2022-07-12 11:41:26 +00:00
* @param {Function|IStore} stateful - The entity such as the redux store or the
* redux {@code getState} function from which the redux state is to be
* returned.
2017-09-01 21:25:48 +00:00
* @returns {Object} The redux state.
*/
2022-07-12 11:41:26 +00:00
export function toState(stateful: Function | IStore) {
if (stateful) {
if (typeof stateful === 'function') {
return stateful();
}
const { getState } = stateful;
2017-09-25 17:31:19 +00:00
if (typeof getState === 'function') {
return getState();
}
}
return stateful;
2017-09-01 21:25:48 +00:00
}