feat(types): rename RenderOptions -> RendererOptions (#3867)

algolia · Oct 23, 2019 · 05c6f72 · 05c6f72
1 parent c3a7d69
commit 05c6f72
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 19 deletions.
diff --git a/src/connectors/infinite-hits/connectInfiniteHits.ts b/src/connectors/infinite-hits/connectInfiniteHits.ts
@@ -1,7 +1,7 @@
 import escapeHits, { TAG_PLACEHOLDER } from '../../lib/escape-highlight';
 import {
   Renderer,
-  RenderOptions,
+  RendererOptions,
   WidgetFactory,
   Hits,
   Unmounter,
@@ -22,16 +22,16 @@ export type InfiniteHitsConnectorParams = Partial<
   InfiniteHitsRendererWidgetParams
 >;
 
-export interface InfiniteHitsRenderOptions<TInfiniteHitsWidgetParams>
-  extends RenderOptions<TInfiniteHitsWidgetParams> {
+export interface InfiniteHitsRendererOptions<TInfiniteHitsWidgetParams>
+  extends RendererOptions<TInfiniteHitsWidgetParams> {
   showPrevious: () => void;
   showMore: () => void;
   isFirstPage: boolean;
   isLastPage: boolean;
 }
 
 export type InfiniteHitsRenderer<TInfiniteHitsWidgetParams> = Renderer<
-  InfiniteHitsRenderOptions<
+  InfiniteHitsRendererOptions<
     InfiniteHitsConnectorParams & TInfiniteHitsWidgetParams
   >
 >;

diff --git a/src/connectors/query-rules/connectQueryRules.ts b/src/connectors/query-rules/connectQueryRules.ts
@@ -1,6 +1,6 @@
 import {
   Renderer,
-  RenderOptions,
+  RendererOptions,
   WidgetFactory,
   Helper,
   HelperChangeEvent,
@@ -35,13 +35,13 @@ export type QueryRulesConnectorParams = {
   transformItems?: ParamTransformItems;
 };
 
-export interface QueryRulesRenderOptions<TQueryRulesWidgetParams>
-  extends RenderOptions<TQueryRulesWidgetParams> {
+export interface QueryRulesRendererOptions<TQueryRulesWidgetParams>
+  extends RendererOptions<TQueryRulesWidgetParams> {
   items: any[];
 }
 
 export type QueryRulesRenderer<TQueryRulesWidgetParams> = Renderer<
-  QueryRulesRenderOptions<QueryRulesConnectorParams & TQueryRulesWidgetParams>
+  QueryRulesRendererOptions<QueryRulesConnectorParams & TQueryRulesWidgetParams>
 >;
 
 export type QueryRulesWidgetFactory<TQueryRulesWidgetParams> = WidgetFactory<

diff --git a/src/connectors/voice-search/connectVoiceSearch.ts b/src/connectors/voice-search/connectVoiceSearch.ts
@@ -3,7 +3,7 @@ import {
   createDocumentationMessageGenerator,
   noop,
 } from '../../lib/utils';
-import { Renderer, RenderOptions, WidgetFactory } from '../../types';
+import { Renderer, RendererOptions, WidgetFactory } from '../../types';
 import createVoiceSearchHelper, {
   VoiceListeningState,
   ToggleListening,
@@ -18,16 +18,16 @@ export type VoiceSearchConnectorParams = {
   searchAsYouSpeak?: boolean;
 };
 
-export interface VoiceSearchRenderOptions<TVoiceSearchWidgetParams>
-  extends RenderOptions<TVoiceSearchWidgetParams> {
+export interface VoiceSearchRendererOptions<TVoiceSearchWidgetParams>
+  extends RendererOptions<TVoiceSearchWidgetParams> {
   isBrowserSupported: boolean;
   isListening: boolean;
   toggleListening: ToggleListening;
   voiceListeningState: VoiceListeningState;
 }
 
 export type VoiceSearchRenderer<TVoiceSearchWidgetParams> = Renderer<
-  VoiceSearchRenderOptions<
+  VoiceSearchRendererOptions<
     VoiceSearchConnectorParams & TVoiceSearchWidgetParams
   >
 >;

diff --git a/src/lib/insights/client.ts b/src/lib/insights/client.ts
@@ -6,7 +6,7 @@ import {
   InsightsClientPayload,
   InsightsClientWrapper,
   Renderer,
-  RenderOptions,
+  RendererOptions,
   Unmounter,
   WidgetFactory,
   SearchResults,
@@ -101,9 +101,9 @@ export default function withInsights(
   connector: Connector<any>
 ): Connector<unknown> {
   const wrapRenderFn = (
-    renderFn: Renderer<RenderOptions<unknown>>
-  ): Renderer<RenderOptions<unknown>> => (
-    renderOptions: RenderOptions,
+    renderFn: Renderer<RendererOptions<unknown>>
+  ): Renderer<RendererOptions<unknown>> => (
+    renderOptions: RendererOptions,
     isFirstRender: boolean
   ) => {
     const { results, hits, instantSearchInstance } = renderOptions;
@@ -123,6 +123,6 @@ export default function withInsights(
     return renderFn(renderOptions, isFirstRender);
   };
 
-  return (renderFn: Renderer<RenderOptions<unknown>>, unmountFn: Unmounter) =>
+  return (renderFn: Renderer<RendererOptions<unknown>>, unmountFn: Unmounter) =>
     connector(wrapRenderFn(renderFn), unmountFn);
 }
diff --git a/src/types/connector.ts b/src/types/connector.ts
@@ -1,15 +1,15 @@
 import { Hits, InstantSearch, SearchResults } from './instantsearch';
 import { InsightsClient } from './insights';
 
-export type RenderOptions<TWidgetParams = unknown> = {
+export type RendererOptions<TWidgetParams = unknown> = {
   widgetParams: TWidgetParams;
   instantSearchInstance: InstantSearch;
   results?: SearchResults;
   hits?: Hits;
   insights?: InsightsClient;
 };
 
-export type Renderer<TRenderOptions extends RenderOptions = any> = (
+export type Renderer<TRenderOptions extends RendererOptions = any> = (
   renderOptions: TRenderOptions,
   isFirstRender: boolean
 ) => void;