Add matchedDocuments in task details for v0.30.0 (#1386)

Add matchedDocuments in task details for v0.30.0 (#1386)

Author: bidoubiwa

src/types/types.ts

@@ -273,6 +273,9 @@ export type TaskObject = Omit<EnqueuedTaskObject, 'taskUid'> & {
     // Number of deleted documents
     deletedDocuments?: number
 
+    // Number of documents found on a batch-delete
+    matchedDocuments?: number
+
     // Primary key on index creation
     primaryKey?: string
 

tests/documents.test.ts

@@ -358,11 +358,15 @@ describe('Documents tests', () => {
 
         const ids = [1, 2]
         const task = await client.index(indexNoPk.uid).deleteDocuments(ids)
-        await client.index(indexNoPk.uid).waitForTask(task.taskUid)
+        const resolvedTask = await client
+          .index(indexNoPk.uid)
+          .waitForTask(task.taskUid)
 
         const documents = await client.index(indexNoPk.uid).getDocuments<Book>()
         const returnedIds = documents.results.map((x) => x.id)
 
+        expect(resolvedTask.details.deletedDocuments).toEqual(2)
+        expect(resolvedTask.details.matchedDocuments).toEqual(2)
         expect(documents.results.length).toEqual(dataset.length - 2)
         expect(returnedIds).not.toContain(ids[0])
         expect(returnedIds).not.toContain(ids[1])