Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add multi object reject notice #173

Merged
merged 1 commit into from Apr 14, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Expand Up @@ -196,6 +196,8 @@ with `propertiesArray`.
}
```

Note that `store.add(arrayOfProperties)` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down Expand Up @@ -307,6 +309,8 @@ Resolves with array of `properties`
}]
```

Note that `store.find(idsOrDocs)` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down Expand Up @@ -416,6 +420,8 @@ Resolves with an Array containing all found and/or added documents:
}]
```

Note that `store.findOrAdd(idsOrDocs)` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down Expand Up @@ -629,6 +635,8 @@ Resolves with an Array of updated documents:
}]
```

Note that `store.update(arrayOfDocs)` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down Expand Up @@ -748,6 +756,8 @@ Resolves with an Array of updated or, if not yet existing, added documents:
}]
```

Note that `store.updateOrAdd(arrayOfDocs)` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down Expand Up @@ -787,6 +797,8 @@ Resolves with an Array of all updated documents:
}]
```

Note that `store.updateAll(changedProperties)` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down Expand Up @@ -823,6 +835,8 @@ Resolves with an Array of all updated documents:
}]
```

Note that `store.updateAll(updateFunction)` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down Expand Up @@ -942,6 +956,8 @@ Resolves with an Array of all deleted documents:
}]
```

Note that `store.remove(idsOrDocs)` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down Expand Up @@ -980,6 +996,8 @@ Resolves with an Array of all deleted documents:
}]
```

Note that `store.removeAll()` behaves like the new [`Promise.allSettled()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled "MDN documentation of Promise.allSettled()")! It resolves with an Array that contains the resulting object or an error for that object.

Rejects with:

| Name | Status | Description | Why |
Expand Down