Merge #1016

1016: refactor(#920): Update the method names r=bidoubiwa a=TheLearneer

Update the stats and version methods names as explained. Fixes #920

Co-authored-by: Santosh Bhandari <[email protected]>

Author: bors[bot]

README.md

@@ -549,13 +549,13 @@ Or using the index object:
 
 - Get database stats
 
-`client.stats(): Promise<Stats>`
+`client.getStats(): Promise<Stats>`
 
 ### Version <!-- omit in toc -->
 
 - Get binary version
 
-`client.version(): Promise<Version>`
+`client.getVersion(): Promise<Version>`
 
 ### Dumps <!-- omit in toc -->
 

src/lib/meilisearch.ts

@@ -188,9 +188,9 @@ class MeiliSearch {
   /**
    * Get the stats of all the database
    * @memberof MeiliSearch
-   * @method stats
+   * @method getStats
    */
-  async stats(): Promise<Stats> {
+  async getStats(): Promise<Stats> {
     const url = `stats`
     return await this.httpRequest.get<Stats>(url)
   }
@@ -202,9 +202,9 @@ class MeiliSearch {
   /**
    * Get the version of MeiliSearch
    * @memberof MeiliSearch
-   * @method version
+   * @method getVersion
    */
-  async version(): Promise<Version> {
+  async getVersion(): Promise<Version> {
     const url = `version`
     return await this.httpRequest.get<Version>(url)
   }

tests/client_tests.ts

@@ -357,15 +357,15 @@ describe.each([
       })
 
       test(`${permission} key: get version`, async () => {
-        await client.version().then((response: Version) => {
+        await client.getVersion().then((response: Version) => {
           expect(response).toHaveProperty('commitSha', expect.any(String))
           expect(response).toHaveProperty('commitDate', expect.any(String))
           expect(response).toHaveProperty('pkgVersion', expect.any(String))
         })
       })
 
       test(`${permission} key: get /stats information`, async () => {
-        await client.stats().then((response: Stats) => {
+        await client.getStats().then((response: Stats) => {
           expect(response).toHaveProperty('databaseSize', expect.any(Number))
           expect(response).toHaveProperty('lastUpdate') // TODO: Could be null, find out why
           expect(response).toHaveProperty('indexes', expect.any(Object))
@@ -432,14 +432,14 @@ describe.each([{ client: publicClient, permission: 'Public' }])(
       })
 
       test(`${permission} key: try to get version and be denied`, async () => {
-        await expect(client.version()).rejects.toHaveProperty(
+        await expect(client.getVersion()).rejects.toHaveProperty(
           'errorCode',
           ErrorStatusCode.INVALID_TOKEN
         )
       })
 
       test(`${permission} key: try to get /stats information and be denied`, async () => {
-        await expect(client.stats()).rejects.toHaveProperty(
+        await expect(client.getStats()).rejects.toHaveProperty(
           'errorCode',
           ErrorStatusCode.INVALID_TOKEN
         )
@@ -525,14 +525,14 @@ describe.each([{ client: anonymousClient, permission: 'No' }])(
       })
 
       test(`${permission} key: try to get version and be denied`, async () => {
-        await expect(client.version()).rejects.toHaveProperty(
+        await expect(client.getVersion()).rejects.toHaveProperty(
           'errorCode',
           ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
         )
       })
 
       test(`${permission} key: try to get /stats information and be denied`, async () => {
-        await expect(client.stats()).rejects.toHaveProperty(
+        await expect(client.getStats()).rejects.toHaveProperty(
           'errorCode',
           ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
         )
@@ -655,7 +655,7 @@ describe.each([
     const route = `stats`
     const client = new MeiliSearch({ host })
     const strippedHost = trailing ? host.slice(0, -1) : host
-    await expect(client.stats()).rejects.toHaveProperty(
+    await expect(client.getStats()).rejects.toHaveProperty(
       'message',
       `request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace(
         'http://',
@@ -668,7 +668,7 @@ describe.each([
     const route = `version`
     const client = new MeiliSearch({ host })
     const strippedHost = trailing ? host.slice(0, -1) : host
-    await expect(client.version()).rejects.toHaveProperty(
+    await expect(client.getVersion()).rejects.toHaveProperty(
       'message',
       `request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace(
         'http://',