UNPKG

@wordpress/data

Version:
162 lines (136 loc) 5.38 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.getCachedResolvers = getCachedResolvers; exports.getIsResolving = getIsResolving; exports.getResolutionError = getResolutionError; exports.getResolutionState = getResolutionState; exports.hasFinishedResolution = hasFinishedResolution; exports.hasResolutionFailed = hasResolutionFailed; exports.hasStartedResolution = hasStartedResolution; exports.isResolving = isResolving; var _utils = require("./utils"); /** * Internal dependencies */ /** @typedef {Record<string, import('./reducer').State>} State */ /** @typedef {import('./reducer').StateValue} StateValue */ /** @typedef {import('./reducer').Status} Status */ /** * Returns the raw resolution state value for a given selector name, * and arguments set. May be undefined if the selector has never been resolved * or not resolved for the given set of arguments, otherwise true or false for * resolution started and completed respectively. * * @param {State} state Data state. * @param {string} selectorName Selector name. * @param {unknown[]?} args Arguments passed to selector. * * @return {StateValue|undefined} isResolving value. */ function getResolutionState(state, selectorName, args) { const map = state[selectorName]; if (!map) { return; } return map.get((0, _utils.selectorArgsToStateKey)(args)); } /** * Returns the raw `isResolving` value for a given selector name, * and arguments set. May be undefined if the selector has never been resolved * or not resolved for the given set of arguments, otherwise true or false for * resolution started and completed respectively. * * @param {State} state Data state. * @param {string} selectorName Selector name. * @param {unknown[]?} args Arguments passed to selector. * * @return {boolean | undefined} isResolving value. */ function getIsResolving(state, selectorName, args) { const resolutionState = getResolutionState(state, selectorName, args); return resolutionState && resolutionState.status === 'resolving'; } /** * Returns true if resolution has already been triggered for a given * selector name, and arguments set. * * @param {State} state Data state. * @param {string} selectorName Selector name. * @param {unknown[]?} args Arguments passed to selector. * * @return {boolean} Whether resolution has been triggered. */ function hasStartedResolution(state, selectorName, args) { return getResolutionState(state, selectorName, args) !== undefined; } /** * Returns true if resolution has completed for a given selector * name, and arguments set. * * @param {State} state Data state. * @param {string} selectorName Selector name. * @param {unknown[]?} args Arguments passed to selector. * * @return {boolean} Whether resolution has completed. */ function hasFinishedResolution(state, selectorName, args) { var _getResolutionState; const status = (_getResolutionState = getResolutionState(state, selectorName, args)) === null || _getResolutionState === void 0 ? void 0 : _getResolutionState.status; return status === 'finished' || status === 'error'; } /** * Returns true if resolution has failed for a given selector * name, and arguments set. * * @param {State} state Data state. * @param {string} selectorName Selector name. * @param {unknown[]?} args Arguments passed to selector. * * @return {boolean} Has resolution failed */ function hasResolutionFailed(state, selectorName, args) { var _getResolutionState2; return ((_getResolutionState2 = getResolutionState(state, selectorName, args)) === null || _getResolutionState2 === void 0 ? void 0 : _getResolutionState2.status) === 'error'; } /** * Returns the resolution error for a given selector name, and arguments set. * Note it may be of an Error type, but may also be null, undefined, or anything else * that can be `throw`-n. * * @param {State} state Data state. * @param {string} selectorName Selector name. * @param {unknown[]?} args Arguments passed to selector. * * @return {Error|unknown} Last resolution error */ function getResolutionError(state, selectorName, args) { const resolutionState = getResolutionState(state, selectorName, args); return (resolutionState === null || resolutionState === void 0 ? void 0 : resolutionState.status) === 'error' ? resolutionState.error : null; } /** * Returns true if resolution has been triggered but has not yet completed for * a given selector name, and arguments set. * * @param {State} state Data state. * @param {string} selectorName Selector name. * @param {unknown[]?} args Arguments passed to selector. * * @return {boolean} Whether resolution is in progress. */ function isResolving(state, selectorName, args) { var _getResolutionState3; return ((_getResolutionState3 = getResolutionState(state, selectorName, args)) === null || _getResolutionState3 === void 0 ? void 0 : _getResolutionState3.status) === 'resolving'; } /** * Returns the list of the cached resolvers. * * @param {State} state Data state. * * @return {State} Resolvers mapped by args and selectorName. */ function getCachedResolvers(state) { return state; } //# sourceMappingURL=selectors.js.map