add public interface on PropTypes object

facebook · Aug 14, 2018 · fc5f1e4 · fc5f1e4
1 parent 9903ce5
commit fc5f1e4
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -284,6 +284,6 @@ PropTypes.checkPropTypes(myPropTypes, props, 'prop', 'MyComponent');
 // `MyComponent`, expected `number`.
 ```
 
-## PropTypes.checkPropTypes.resetWarningCache
+## PropTypes.resetWarningCache()
 
-`PropTypes.checkPropTypes` only `console.error.log(...)`s a given message once.  To reset the cache while testing call `PropTypes.checkPropTypes.resetWarningCache()`
+`PropTypes.checkPropTypes(...)` only `console.error.log(...)`s a given message once.  To reset the cache while testing call `PropTypes.resetWarningCache()`
diff --git a/__tests__/PropTypesDevelopmentReact15.js b/__tests__/PropTypesDevelopmentReact15.js
@@ -226,6 +226,30 @@ describe('PropTypesDevelopmentReact15', () => {
     });
   });
 
+  describe('resetWarningCache', () => {
+    it("should reset warning cache", () => {
+      spyOn(console, 'error');
+      const propTypes = { foo: undefined };
+      const props = { foo: 'foo' };
+      PropTypes.checkPropTypes(
+        propTypes,
+        props,
+        'prop',
+        'testComponent',
+        null,
+      );
+      PropTypes.resetWarningCache();
+      PropTypes.checkPropTypes(
+        propTypes,
+        props,
+        'prop',
+        'testComponent',
+        null,
+      );
+      expect(console.error.calls.count()).toEqual(2);
+    });
+  });
+
   describe('Primitive Types', () => {
     it('should warn for invalid strings', () => {
       typeCheckFail(

diff --git a/__tests__/PropTypesDevelopmentStandalone-test.js b/__tests__/PropTypesDevelopmentStandalone-test.js
@@ -222,6 +222,30 @@ describe('PropTypesDevelopmentStandalone', () => {
     });
   });
 
+  describe('resetWarningCache', () => {
+    it("should reset warning cache", () => {
+      spyOn(console, 'error')
+      const propTypes = { foo: undefined };
+      const props = { foo: 'foo' };
+      PropTypes.checkPropTypes(
+        propTypes,
+        props,
+        'prop',
+        'testComponent',
+        null,
+      );
+      PropTypes.resetWarningCache();
+      PropTypes.checkPropTypes(
+        propTypes,
+        props,
+        'prop',
+        'testComponent',
+        null,
+      );
+      expect(console.error.calls.count()).toEqual(2);
+    })
+  })
+
   describe('Primitive Types', () => {
     it('should warn for invalid strings', () => {
       typeCheckFail(

diff --git a/__tests__/PropTypesProductionReact15-test.js b/__tests__/PropTypesProductionReact15-test.js
@@ -970,4 +970,13 @@ describe('PropTypesProductionReact15', () => {
       });
     });
   });
+  describe('resetWarningCache', () => {
+    it("should provide empty function", () => {
+      spyOn(console, 'error')
+
+      var spy = jest.fn();
+      PropTypes.resetWarningCache();
+      expect(spy).not.toBeCalled();
+    });
+  });
 });
diff --git a/__tests__/PropTypesProductionStandalone-test.js b/__tests__/PropTypesProductionStandalone-test.js
@@ -236,11 +236,21 @@ describe('PropTypesProductionStandalone', function() {
     describe('checkPropTypes.resetWarningCache', () => {
       it("should provide empty function", () => {
         spyOn(console, 'error')
-        
+
         var spy = jest.fn();
         PropTypes.checkPropTypes.resetWarningCache();
         expect(spy).not.toBeCalled();
       });
     });
   });
+
+  describe('resetWarningCache', () => {
+    it("should provide empty function", () => {
+      spyOn(console, 'error')
+
+      var spy = jest.fn();
+      PropTypes.resetWarningCache();
+      expect(spy).not.toBeCalled();
+    });
+  });
 });
diff --git a/factoryWithThrowingShims.js b/factoryWithThrowingShims.js
@@ -54,6 +54,7 @@ module.exports = function() {
 
   ReactPropTypes.checkPropTypes = emptyFunction;
   ReactPropTypes.checkPropTypes.resetWarningCache = emptyFunction;
+  ReactPropTypes.resetWarningCache = emptyFunction;
   ReactPropTypes.PropTypes = ReactPropTypes;
 
   return ReactPropTypes;

diff --git a/factoryWithTypeCheckers.js b/factoryWithTypeCheckers.js
@@ -550,6 +550,7 @@ module.exports = function(isValidElement, throwOnDirectAccess) {
   }
 
   ReactPropTypes.checkPropTypes = checkPropTypes;
+  ReactPropTypes.resetWarningCache = checkPropTypes.resetWarningCache;
   ReactPropTypes.PropTypes = ReactPropTypes;
 
   return ReactPropTypes;