How to type an object as being Values that can be passed in to a serializer or set state action?

[neefrehman]

I'm currently working on an abstracted pagination state hook, and would like to return an object that callers can choose to pass into a serializePaginationSearchParams or setPaginationState function (that the hook also returns). This would allow for simple clearing of state with a good level of composability (enabling callers to choose whether to "push" or "replace" state, for example). But, I'm struggling to type this object in a way that will be accepted by both functions, does anyone know how I could do this?

// simplified version of hook implementation

const [paginationState, setPaginationState] = useQueryStates(searchParams, {
    history: 'push',
});

const serializePaginationSearchParams = createSerializer(searchParams)

const emptyPaginationStateParams = {
    [paginationSearchParamKeys.before]: null,
    [paginationSearchParamKeys.after]: null,
    [paginationSearchParamKeys.first]: null,
    [paginationSearchParamKeys.last]: null,
};

return { setPaginationState, serializePaginationSearchParams, emptyPaginationStateParams }

// callsite

// How should I type `emptyPaginationStateParams` such that this works?
setPaginationState(emptyPaginationStateParams, { history: "replace" })
serializePaginationSearchParams(emptyPaginationStateParams)

[franky47]

For the clearing part, you should be able to call setPaginationState(null, { /* options here */ }). This will clear all search params that were declared to the useQueryStates hook, without having to enumerate them (available since 1.19.1).

That being said, the serializer doesn't have this behaviour, but it could be something nice to add. Would you like to open a PR?

Something else that might be of use is the inferParserType utility.

[neefrehman]

Thanks @franky47! I've just opened a PR here: #657