Change name of searchForFacetValue to searchForFacetValues

Author: bidoubiwa

README.md

@@ -412,12 +412,12 @@ client.multiSearch(queries?: MultiSearchParams, config?: Partial<Request>): Prom
 
 `multiSearch` uses the `POST` method when performing its request to Meilisearch.
 
-### Search For Facet Value
+### Search For Facet Values
 
-#### [Search for facet value](#)
+#### [Search for facet values](#)
 
 ```ts
-client.index<T>('xxx').searchForFacetValue(params: SearchForFacetValuesParams, config?: Partial<Request>): Promise<SearchForFacetValuesResponse>
+client.index<T>('xxx').searchForFacetValues(params: SearchForFacetValuesParams, config?: Partial<Request>): Promise<SearchForFacetValuesResponse>
 ```
 
 ### Documents <!-- omit in toc -->

src/indexes.ts

@@ -155,7 +155,7 @@ class Index<T extends Record<string, any> = Record<string, any>> {
    * @param config - Additional request configuration options
    * @returns Promise containing the search response
    */
-  async searchForFacetValue(
+  async searchForFacetValues(
     params: SearchForFacetValuesParams,
     config?: Partial<Request>
   ): Promise<SearchForFacetValuesResponse> {

tests/facet_search.test.ts

@@ -40,7 +40,6 @@ describe.each([
     await clearAllIndexes(config)
     const client = await getClient('Master')
     const newFilterableAttributes = ['genres', 'title']
-
     await client.createIndex(index.uid)
     await client.index(index.uid).updateSettings({
       filterableAttributes: newFilterableAttributes,
@@ -49,14 +48,14 @@ describe.each([
     await client.waitForTask(taskUid)
   })
 
-  test(`${permission} key: basic facet value search`, async () => {
+  test.only(`${permission} key: basic facet value search`, async () => {
     const client = await getClient(permission)
 
     const params = {
       facetQuery: 'a',
       facetName: 'genres',
     }
-    const response = await client.index(index.uid).searchForFacetValue(params)
+    const response = await client.index('games').searchForFacetValues(params)
 
     expect(response.hits.length).toEqual(2)
     expect(response.query).toEqual('a')
@@ -68,7 +67,7 @@ describe.each([
     const params = {
       facetName: 'genres',
     }
-    const response = await client.index(index.uid).searchForFacetValue(params)
+    const response = await client.index(index.uid).searchForFacetValues(params)
 
     expect(response.hits.length).toEqual(4)
     expect(response.query).toEqual(null)
@@ -82,7 +81,8 @@ describe.each([
       facetQuery: 'a',
       filter: ['genres = action'],
     }
-    const response = await client.index(index.uid).searchForFacetValue(params)
+
+    const response = await client.index(index.uid).searchForFacetValues(params)
 
     expect(response.hits.length).toEqual(1)
   })
@@ -95,7 +95,7 @@ describe.each([
       facetQuery: 'a',
       q: 'Alice',
     }
-    const response = await client.index(index.uid).searchForFacetValue(params)
+    const response = await client.index(index.uid).searchForFacetValues(params)
 
     expect(response.hits.length).toEqual(1)
   })