From d53eea2ca875250db862aeb82de4622c0fb44bbf Mon Sep 17 00:00:00 2001 From: Peter Mekhaeil <4616064+petermekhaeil@users.noreply.github.com> Date: Tue, 7 Feb 2023 23:24:06 +0800 Subject: [PATCH] docs: Add missing keys to BaseQueryApi --- docs/rtk-query/api/createApi.mdx | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/rtk-query/api/createApi.mdx b/docs/rtk-query/api/createApi.mdx index a556be3f86..d4984f9362 100644 --- a/docs/rtk-query/api/createApi.mdx +++ b/docs/rtk-query/api/createApi.mdx @@ -82,11 +82,15 @@ export const { useGetPokemonByNameQuery } = pokemonApi #### baseQuery function arguments - `args` - The return value of the `query` function for a given endpoint -- `api` - The `BaseQueryApi` object, containing `signal`, `dispatch`, `getState` and `extra` properties +- `api` - The `BaseQueryApi` object contains: - `signal` - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) object that may be used to abort DOM requests and/or read whether the request is aborted. + - `abort` - The [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) method of the AbortController attached to `signal`. - `dispatch` - The `store.dispatch` method for the corresponding Redux store - `getState` - A function that may be called to access the current store state - `extra` - Provided as thunk.extraArgument to the configureStore getDefaultMiddleware option. + - `endpoint` - The name of the endpoint. + - `type` - Type of request (`query` or `mutation`). + - `forced` - Indicates if a query has been forced. - `extraOptions` - The value of the optional `extraOptions` property provided for a given endpoint #### baseQuery function signature @@ -106,8 +110,13 @@ export type BaseQueryFn< export interface BaseQueryApi { signal: AbortSignal + abort: (reason?: string) => void dispatch: ThunkDispatch getState: () => unknown + extra: unknown + endpoint: string + type: 'query' | 'mutation' + forced?: boolean } export type QueryReturnValue =