/** * @license * MIT License * * Copyright (c) 2021 Alexis Munsayac * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * * * @author Alexis Munsayac * @copyright Alexis Munsayac 2021 */ import { useDebugValue } from 'preact/hooks'; import { useConditionalCallback, } from '@lyonph/preact-hooks'; import { ScopedModel } from '../create-model'; import { defaultCompare, compareList, ListCompare, } from '../utils/comparer'; import useSelector, { SelectorFn } from './useSelector'; export type SelectorsFn = SelectorFn; /** * Transforms the model's state into a list of values and * listens for the changes from one of the values.. * * If a value changes, the component re-renders. * * uses the `Object.is` function for comparison by default. * * @param model the scoped model to read the state from * @param selector a function that receives the model state * @param shouldUpdate a function that compares the * previously transformed value to the newly transformed value * and if it should replace the previous value and perform an update. */ export default function useSelectors( model: ScopedModel, selector: SelectorsFn, shouldUpdate: ListCompare = defaultCompare, ): R { const compare = useConditionalCallback( (a, b) => ( compareList(a, b, shouldUpdate) ), shouldUpdate, ); const value = useSelector(model, selector, compare); useDebugValue(value); return value; }