From ab67a96fc0aa8351a78ad702882bef095602ba59 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Chalifour?= <francois.chalifour@gmail.com>
Date: Mon, 26 Oct 2020 11:49:39 +0100
Subject: [PATCH] feat: rename `item` to `hit` in highlight utils

---
 examples/js/app.ts                        |  6 +++---
 packages/autocomplete-js/src/highlight.ts | 24 +++++++++++------------
 2 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/examples/js/app.ts b/examples/js/app.ts
index a36b36d73..d021723f3 100644
--- a/examples/js/app.ts
+++ b/examples/js/app.ts
@@ -4,7 +4,7 @@ import {
   autocomplete,
   AutocompleteSource,
   getAlgoliaHits,
-  reverseHighlightItem,
+  reverseHighlightHit,
 } from '@algolia/autocomplete-js';
 import { createRecentSearchesPlugin } from '@algolia/autocomplete-plugin-recent-searches';
 import '@algolia/autocomplete-plugin-recent-searches/style';
@@ -51,8 +51,8 @@ autocomplete<Hit<QuerySuggestionHit>>({
               return `
                 <div class="item-icon">${searchIcon}</div>
                 <div>
-                  ${reverseHighlightItem({
-                    item,
+                  ${reverseHighlightHit({
+                    hit: item,
                     attribute: 'query',
                   })}
                 </div>
diff --git a/packages/autocomplete-js/src/highlight.ts b/packages/autocomplete-js/src/highlight.ts
index 449223fb8..fbe0bbcc2 100644
--- a/packages/autocomplete-js/src/highlight.ts
+++ b/packages/autocomplete-js/src/highlight.ts
@@ -36,8 +36,8 @@ type HighlightItemParams<TItem> = {
 /**
  * Highlights and escapes the matching parts of an Algolia hit.
  */
-export function highlightItem<TItem extends Hit<{}>>({
-  item,
+export function highlightHit<TItem extends Hit<{}>>({
+  item: hit,
   attribute,
   highlightPreTag = '<mark>',
   highlightPostTag = '</mark>',
@@ -45,7 +45,7 @@ export function highlightItem<TItem extends Hit<{}>>({
 }: HighlightItemParams<TItem>) {
   return concatParts(
     parseAlgoliaHitHighlight<TItem>({
-      hit: item,
+      hit,
       attribute,
       ignoreEscape,
     }),
@@ -58,8 +58,8 @@ export function highlightItem<TItem extends Hit<{}>>({
  *
  * This is a common pattern for Query Suggestions.
  */
-export function reverseHighlightItem<TItem extends Hit<{}>>({
-  item,
+export function reverseHighlightHit<TItem extends Hit<{}>>({
+  item: hit,
   attribute,
   highlightPreTag = '<mark>',
   highlightPostTag = '</mark>',
@@ -67,7 +67,7 @@ export function reverseHighlightItem<TItem extends Hit<{}>>({
 }: HighlightItemParams<TItem>) {
   return concatParts(
     parseAlgoliaHitReverseHighlight<TItem>({
-      hit: item,
+      hit,
       attribute,
       ignoreEscape,
     }),
@@ -78,8 +78,8 @@ export function reverseHighlightItem<TItem extends Hit<{}>>({
 /**
  * Highlights and escapes the matching parts of an Algolia hit snippet.
  */
-export function snippetItem<TItem extends Hit<{}>>({
-  item,
+export function snippetHit<TItem extends Hit<{}>>({
+  item: hit,
   attribute,
   highlightPreTag = '<mark>',
   highlightPostTag = '</mark>',
@@ -87,7 +87,7 @@ export function snippetItem<TItem extends Hit<{}>>({
 }: HighlightItemParams<TItem>) {
   return concatParts(
     parseAlgoliaHitSnippet<TItem>({
-      hit: item,
+      hit,
       attribute,
       ignoreEscape,
     }),
@@ -100,8 +100,8 @@ export function snippetItem<TItem extends Hit<{}>>({
  *
  * This is a common pattern for Query Suggestions.
  */
-export function reverseSnippetItem<TItem extends Hit<{}>>({
-  item,
+export function reverseSnippetHit<TItem extends Hit<{}>>({
+  item: hit,
   attribute,
   highlightPreTag = '<mark>',
   highlightPostTag = '</mark>',
@@ -109,7 +109,7 @@ export function reverseSnippetItem<TItem extends Hit<{}>>({
 }: HighlightItemParams<TItem>) {
   return concatParts(
     parseAlgoliaHitReverseSnippet<TItem>({
-      hit: item,
+      hit,
       attribute,
       ignoreEscape,
     }),