DAB
Search…
bulkRemove
1
bulkRemove(body, param)
Copied!

Arguments

Body (array, required)

Body is always an array of strings or numbers. Those represent the ID of its corresponding documents
Example:
1
[ 'james-bond', 'jack-bauer-001', 'johnny-english', ... ]
Copied!

Params (required)

  • collection: Required, the name of collection you want to work with.
  • withDetail: Optional, defaults to false. If true, details of operation will be returned. It is an array of objects in the same order as body request above. See example below.

Response

Method should always return a response, eventhough one or more removal could fail. If failed, those corresponding rows should tell why it failed, assuming it is enabled through withDetail parameter above.
The order of removal result should match with the order of body request.
Promise rejection error should only occour when something very bad happened within the script.
Example:
1
{
2
success: true,
3
stat: {
4
ok: 1,
5
fail: 2,
6
total: 3
7
},
8
detail: [
9
{ _id: 'james-bond', success: true },
10
{ _id: 'jack-bauer-001', success: false, message: 'Document not found' },
11
{ _id: 'johnny-english', success: false, message: 'Document not found' }
12
]
13
}
Copied!
Last modified 3yr ago