add updateDocuments to the function list

Author: charlotte

README.md

@@ -70,7 +70,7 @@ let documents = [
   { book_id: 42, title: "The Hitchhiker's Guide to the Galaxy" },
 ]
 
-await meili.Index('books').addDocuments(documents) // { "updateId": 0 }
+await meili.Index('books').addOrReplaceDocuments(documents) // { "updateId": 0 }
 ```
 
 With the `updateId`, you can check the status (`processed` of `failed`) of your documents addition thanks to this [method](#update-status).
@@ -146,7 +146,7 @@ let myDocuments = await meili
 #### Add documents <!-- omit in toc -->
 
 ```javascript
-meili.Index('books').addDocuments([{ book_id: 2, title: 'Madame Bovary' }])
+meili.Index('books').addOrReplaceDocuments([{ book_id: 2, title: 'Madame Bovary' }])
 ```
 
 Response:
@@ -333,10 +333,14 @@ This package works for MeiliSearch `v0.9.x`.
 
 ### Documents
 
-- Add or update multiples documents:
+- Add or replace multiple documents:
 
 `meili.Index('xxx').addDocuments(documents: object[]): Promise<Types.AsyncUpdateId>`
 
+- Add or update multiple documents:
+
+`meili.Index('xxx').updateDocuments(documents: object[]): Promise<Types.AsyncUpdateId>`
+
 - Get Documents:
 
 `meili.Index('xxx').getDocuments(params: Types.getDocumentsParams): Promise<object[]>`
@@ -349,7 +353,7 @@ This package works for MeiliSearch `v0.9.x`.
 
 `meili.Index('xxx').deleteDocument(documentId: string): Promise<Types.AsyncUpdateId>`
 
-- Delete multiples documents:
+- Delete multiple documents:
 
 `meili.Index('xxx').deleteDocuments(documentsIds: string[]): Promise<Types.AsyncUpdateId>`
 

src/__tests__/indexes.ts

@@ -133,6 +133,16 @@ test('add-documents', async () => {
     meili.Index(indexAndIndentifier.uid).addDocuments(dataset)
   ).resolves.toHaveProperty('updateId')
 })
+test('update-documents', async () => {
+  await expect(
+    meili.Index(index.uid).updateDocuments(dataset, {
+      primaryKey: 'id',
+    })
+  ).resolves.toHaveProperty('updateId')
+  await expect(
+    meili.Index(indexAndIndentifier.uid).addDocuments(dataset)
+  ).resolves.toHaveProperty('updateId')
+})
 
 test('get-index-primary-key', async () => {
   await sleep(3 * 1000)
@@ -153,7 +163,7 @@ test('updates', async () => {
   await expect(meili.Index(index.uid).getUpdateStatus(0)).resolves.toHaveProperty(
     'status'
   )
-  await expect(meili.Index(index.uid).getAllUpdateStatus()).resolves.toHaveLength(1)
+  await expect(meili.Index(index.uid).getAllUpdateStatus()).resolves.toHaveLength(2)
 })
 
 test('get-document', async () => {
@@ -508,7 +518,7 @@ test('delete-documents', async () => {
   await expect(
     meili.Index(index.uid).deleteDocuments([firstDocumentId, offsetDocumentId])
   ).resolves.toHaveProperty('updateId')
-  await sleep(1000)
+  await sleep(2000)
   await expect(
     meili.Index(index.uid).getDocument(firstDocumentId)
   ).rejects.toThrow()

src/indexes.ts

@@ -198,7 +198,7 @@ class Indexes {
   }
 
   /**
-   * Add or update multiples documents to an index
+   * Add or replace multiples documents to an index
    * @memberof Documents
    * @method addDocuments
    */
@@ -213,6 +213,22 @@ class Indexes {
     })
   }
 
+  /**
+   * Add or update multiples documents to an index
+   * @memberof Documents
+   * @method updateDocuments
+   */
+  updateDocuments(
+    documents: object[],
+    options?: Types.AddDocumentParams
+  ): Promise<Types.AsyncUpdateId> {
+    const url = `/indexes/${this.indexUid}/documents`
+
+    return this.instance.put(url, documents, {
+      params: options,
+    })
+  }
+
   /**
    * Delete one document
    * @memberof Documents