fix: rename global "disableCaching" to "disableGlobalCaching"

typegoose · Feb 9, 2023 · 5deb0eb · 5deb0eb
1 parent 78ac3bc
commit 5deb0eb
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 13 deletions.
diff --git a/docs/api/decorators/modelOptions.md b/docs/api/decorators/modelOptions.md
@@ -273,7 +273,7 @@ Default: `false`
 
 Disable Caching for current Class (and all classes extending it) or for just a call (for [`buildSchema`](../functions/buildSchema.md) / [`getModelForClass`](../functions/getModelForClass.md) / [`getDiscriminatorModelForClass`](../functions/getDiscriminatorModelForClass.md)).
 
-This Option will NOT overwrite the global [`disableCaching`](../functions/setGlobalOptions.md#disablecaching).
+This Option will NOT overwrite the global [`disableGlobalCaching`](../functions/setGlobalOptions.md#disableglobalcaching) if set.
 
 Example:
 

diff --git a/docs/api/functions/setGlobalOptions.md b/docs/api/functions/setGlobalOptions.md
@@ -27,7 +27,7 @@ The `setGlobalOptions` call has to be before any `buildSchema` (by extension als
 
 ```ts
 setGlobalOptions({ options: { allowMixed: Severity.ERROR } });
-setGlobalOptions({ globalOptions: { disableCaching: true } }); // does not affect the previous setting of "options"
+setGlobalOptions({ globalOptions: { disableGlobalCaching: true } }); // does not affect the previous setting of "options"
 setGlobalOptions({ globalOptions: { someOtherOption: true } }); // does not affect the previous setting of "globalOptions"
 setGlobalOptions({ options: { disableLowerIndexes: true, allowMixed: Severity.WARN } }); // will overwrite previous setting of "allowMixed"
 
@@ -38,15 +38,15 @@ setGlobalOptions({ options: { disableLowerIndexes: true, allowMixed: Severity.WA
     disableLowerIndexes: true
   },
   globalOptions: {
-    disableCaching: true,
+    disableGlobalCaching: true,
     someOtherOption: true
   }
 }
 ```
 
 ## Global Typegoose Options {#options}
 
-### disableCaching
+### disableGlobalCaching
 
 Default: `false`
 

diff --git a/docs/guides/advanced/models-with-same-name.mdx b/docs/guides/advanced/models-with-same-name.mdx
@@ -75,15 +75,15 @@ expect(model.modelName).to.be.equal('CustomNameOption_CustomName');
 
 ## Disable Caching
 
-Since Typegoose `10.2.0` there is also the option of disabling the cache globally with [global options](../../api/functions/setGlobalOptions.md#disablecaching) or locally via [`@modelOptions`](../../api/decorators/modelOptions.md#disablecaching).
+Since Typegoose `10.2.0` there is also the option of disabling the cache globally with [`setGlobalOptions`](../../api/functions/setGlobalOptions.md)'s [`disableGlobalCaching`](../../api/functions/setGlobalOptions.md#disableglobalcaching) or locally via [`@modelOptions`](../../api/decorators/modelOptions.md#disablecaching).
 
 <Tabs groupId="caching-global-local">
   <TabItem value="global" label="Disable Cache globally">
 
 ```ts
 import { setGlobalOptions } from "@typegoose/typegoose";
 
-setGlobalOptions({ globalOptions: { disableCaching: true } });
+setGlobalOptions({ globalOptions: { disableGlobalCaching: true } });
 
 class Kitten {
   @prop()
@@ -157,7 +157,7 @@ const KittenModelCon1 = getModelForClass(Kitten, { existingConnection: mongoose.
 Models still cannot be defined more than once in the same connection / mongoose instance.
 :::
 :::caution
-Setting the Cache to be disabled globally will make some functions that rely on it error, see [`E033`](../error-warning-details.md#cache-disabled-e033) and [`disableCaching`](../../api/functions/setGlobalOptions.md#disablecaching) which effects it will have.
+Setting the Cache to be disabled globally will make some functions that rely on it error, see [`E033`](../error-warning-details.md#cache-disabled-e033) and [`disableGlobalCaching`](../../api/functions/setGlobalOptions.md#disableglobalcaching) which effects it will have.
 :::
 
 ## Notes

diff --git a/src/internal/utils.ts b/src/internal/utils.ts
@@ -748,7 +748,7 @@ export function mapModelOptionsToNaming(options: IModelOptions | undefined): INa
  * @returns "true" if caching is enabled or "false" if disabled
  */
 export function isGlobalCachingEnabled(): boolean {
-  return !(globalOptions.globalOptions?.disableCaching === true);
+  return !(globalOptions.globalOptions?.disableGlobalCaching === true);
 }
 
 /**

diff --git a/src/types.ts b/src/types.ts
@@ -642,7 +642,7 @@ export interface ITypegooseOptions {
    * "false" and "undefined" have the same result of enabling caching
    * @default false
    */
-  disableCaching?: boolean;
+  disableGlobalCaching?: boolean;
 }
 
 /** Interface describing a Object that has a "typegooseName" Function */

diff --git a/test/tests/disableCache.test.ts b/test/tests/disableCache.test.ts
@@ -11,11 +11,11 @@ beforeEach(() => {
 describe('global', () => {
   beforeAll(() => {
     globalOptions['globalOptions'] = globalOptions['globalOptions'] ?? {};
-    globalOptions['globalOptions'].disableCaching = true;
+    globalOptions['globalOptions'].disableGlobalCaching = true;
   });
 
   afterAll(() => {
-    delete globalOptions['globalOptions']!.disableCaching;
+    delete globalOptions['globalOptions']!.disableGlobalCaching;
 
     mongoose.deleteModel(/.*/); // typegoose does not cache the model, but mongoose still does per connection / mongoose instance
   });

diff --git a/test/tests/errors.test.ts b/test/tests/errors.test.ts
@@ -883,11 +883,11 @@ describe('tests for "DuplicateOptionsError" [E031]', () => {
 describe('tests for "CacheDisabledError" [E033]', () => {
   beforeAll(() => {
     globalOptions['globalOptions'] = globalOptions['globalOptions'] ?? {};
-    globalOptions['globalOptions'].disableCaching = true;
+    globalOptions['globalOptions'].disableGlobalCaching = true;
   });
 
   afterAll(() => {
-    delete globalOptions['globalOptions']!.disableCaching;
+    delete globalOptions['globalOptions']!.disableGlobalCaching;
   });
 
   it('should throw a Error when trying to use "getClass" but caching is disabled', () => {