rename createPureApi to createBaseApi (#137)

* rename createPureApi to createBaseApi

Co-authored-by: Matt Sutkowski <[email protected]>

Author: phryneas

docs/concepts/customizing-create-api.md

@@ -9,7 +9,7 @@ hide_title: true
 
 Currently, RTK Query includes two variants of `createApi`:
 
-- `createPureApi` which contains only the basic redux logic (the core module)
+- `createBaseApi` which contains only the basic redux logic (the core module)
 - `createApi` which contains both the core and react-hooks modules
 
 You can create your own versions of `createApi` by either specifying non-default options for the modules or by adding your own modules.

examples/svelte/src/services/counter.ts

@@ -1,4 +1,4 @@
-import { createApi, fetchBaseQuery, retry } from '@rtk-incubator/rtk-query';
+import { createBaseApi, fetchBaseQuery, retry } from '@rtk-incubator/rtk-query';
 
 interface CountResponse {
     count: number;
@@ -9,7 +9,9 @@ const baseQuery = retry(
         baseUrl: '/',
     }),
 );
-export const counterApi = createApi({
+
+// We use createBaseApi here as it is only the core and does not include any React-related code (such as hooks)
+export const counterApi = createBaseApi({
     reducerPath: 'counterApi',
     baseQuery,
     entityTypes: ['Counter'],

examples/svelte/src/store.ts

@@ -1,6 +1,7 @@
 import { configureStore, EnhancedStore } from '@reduxjs/toolkit';
 import { counterApi } from './services/counter';
 import { Readable, readable, writable } from 'svelte/store';
+import { setupListeners } from '@rtk-incubator/rtk-query';
 
 const reduxStore = configureStore({
     reducer: {
@@ -29,6 +30,8 @@ const bindReduxStore = <T extends EnhancedStore<any, any, any>>(
     };
 };
 
+setupListeners(reduxStore.dispatch);
+
 export const store = bindReduxStore(reduxStore);
 
 export const globalPollingEnabled = writable(true);

package.json

@@ -67,9 +67,9 @@
       "limit": "15 KB"
     },
     {
-      "name": "createPureApi + setupListeners",
+      "name": "createBaseApi + setupListeners",
       "path": "dist/esm/index.js",
-      "import": "{ createPureApi, setupListeners }"
+      "import": "{ createBaseApi, setupListeners }"
     },
     {
       "name": "createApi + setupListeners",

src/index.ts

@@ -15,5 +15,5 @@ export { setupListeners } from './core/setupListeners';
 export type { CreateApi, CreateApiOptions } from './createApi';
 export { buildCreateApi } from './createApi';
 
-export { createApi as createPureApi, coreModule } from './core';
+export { createApi as createBaseApi, coreModule } from './core';
 export { createApi, reactHooksModule } from './react-hooks';

website/sidebars.js

@@ -12,6 +12,7 @@ module.exports = {
       'concepts/optimistic-updates',
       'concepts/code-splitting',
       'concepts/code-generation',
+      'concepts/customizing-create-api',
     ],
     'API Reference': ['api/createApi', 'api/fetchBaseQuery', 'api/ApiProvider', 'api/setupListeners'],
     Examples: [