1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
GoToSocial
Copyright (C) GoToSocial Authors admin@gotosocial.org
SPDX-License-Identifier: AGPL-3.0-or-later
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import { Draft } from "@reduxjs/toolkit";
/**
* Pass into a query when you don't
* want to provide an argument to it.
*/
export const NoArg = undefined;
/**
* Shadow the redux onQueryStarted function for mutations.
* https://redux-toolkit.js.org/rtk-query/api/createApi#onquerystarted
*/
type OnMutationStarted = (
_arg: any,
_params: MutationStartedParams
) => Promise<void>;
/**
* Shadow the redux onQueryStarted function parameters for mutations.
* https://redux-toolkit.js.org/rtk-query/api/createApi#onquerystarted
*/
interface MutationStartedParams {
/**
* The dispatch method for the store.
*/
dispatch,
/**
* A method to get the current state for the store.
*/
getState,
/**
* extra as provided as thunk.extraArgument to the configureStore getDefaultMiddleware option.
*/
extra,
/**
* A unique ID generated for the query/mutation.
*/
requestId,
/**
* A Promise that will resolve with a data property (the transformed query result), and a
* meta property (meta returned by the baseQuery). If the query fails, this Promise will
* reject with the error. This allows you to await for the query to finish.
*/
queryFulfilled,
/**
* A function that gets the current value of the cache entry.
*/
getCacheEntry,
}
export type Action = (
_draft: Draft<any>,
_updated: any,
_params: ActionParams,
) => void;
export interface ActionParams {
/**
* Either a normal old string, or a custom
* function to derive the key to change based
* on the draft and updated data.
*
* @param _draft
* @param _updated
* @returns
*/
key?: string | ((_draft: Draft<any>, _updated: any) => string),
}
/**
* Custom cache mutation.
*/
export type CacheMutation = (
_queryName: string | ((_arg: any) => string),
_params?: ActionParams,
) => { onQueryStarted: OnMutationStarted }
|
