fix: rename useCartoLayerFilterProps hook to useCartoLayerProps

CartoDB · Mar 10, 2021 · f8fd801 · f8fd801
1 parent cf2d821
commit f8fd801
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/packages/react-api/__tests__/hooks/useCartoLayerFilterProps.test.js b/packages/react-api/__tests__/hooks/useCartoLayerFilterProps.test.js
@@ -1,12 +1,12 @@
 import { DataFilterExtension } from '@deck.gl/extensions';
 import { renderHook } from '@testing-library/react-hooks';
-import useCartoLayerFilterProps from '../../src/hooks/useCartoLayerFilterProps';
+import useCartoLayerProps from '../../src/hooks/useCartoLayerProps';
 import { mockClear, mockReduxHooks } from '../mockReduxHooks';
 
-describe('useCartoLayerFilterProps', () => {
+describe('useCartoLayerProps', () => {
   mockReduxHooks();
 
-  const { result } = renderHook(() => useCartoLayerFilterProps());
+  const { result } = renderHook(() => useCartoLayerProps());
 
   it('should return correct filter props', () => {
     expect(Object.keys(result.current)).toEqual([

diff --git a/packages/react-api/reference.md b/packages/react-api/reference.md
@@ -55,7 +55,7 @@ Returns a number (0-1) or a boolean checking wether a feature should be rendered
 | filters | <code>Object</code> | {}        | Filters to be applied                |
 | type    | <code>string</code> | 'boolean' | Output type: number (0-1) or boolean |
 
-## useCartoLayerFilterProps ⇒ <code>Object</code>
+## useCartoLayerProps ⇒ <code>Object</code>
 
 Returns required default props for layers. It manages filtering and viewport changes.
 

diff --git a/...api/src/hooks/useCartoLayerFilterProps.js → ...react-api/src/hooks/useCartoLayerProps.js b/...api/src/hooks/useCartoLayerFilterProps.js → ...react-api/src/hooks/useCartoLayerProps.js
@@ -2,7 +2,7 @@ import { DataFilterExtension } from '@deck.gl/extensions';
 import { debounce, _buildFeatureFilter } from '@carto/react-core';
 import useViewportFeatures from './useViewportFeatures';
 
-export default function useCartoLayerFilterProps(
+export default function useCartoLayerProps(
   source,
   uniqueIdProperty = 'cartodb_id'
 ) {

diff --git a/packages/react-api/src/index.js b/packages/react-api/src/index.js
@@ -1,5 +1,5 @@
 export { executeSQL } from './api/SQL';
 export { SourceTypes } from './api/SourceTypes';
 
-export { default as useCartoLayerFilterProps } from './hooks/useCartoLayerFilterProps';
+export { default as useCartoLayerProps } from './hooks/useCartoLayerProps';