@sanity/client 2.23.2-next.3 → 2.23.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +34 -4
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -273,12 +273,16 @@ const reviewsToRemove = ['reviews[0]', 'reviews[_key=="abc123"]']
273
273
  client.patch('bike-123').unset(reviewsToRemove).commit()
274
274
  ```
275
275
 
276
- ### Delete a document
276
+ ### Delete documents
277
+
278
+ A single document can be deleted by specifying a document ID:
279
+
280
+ `client.delete(docId)`
277
281
 
278
282
  ```js
279
283
  client
280
284
  .delete('bike-123')
281
- .then((res) => {
285
+ .then(() => {
282
286
  console.log('Bike deleted')
283
287
  })
284
288
  .catch((err) => {
@@ -286,9 +290,35 @@ client
286
290
  })
287
291
  ```
288
292
 
289
- `client.delete(docId)`
293
+ One or more documents can be deleted by specifying a GROQ query (and optionally, `params`):
294
+
295
+ `client.delete({ query: "GROQ query", params: { key: value } })`
290
296
 
291
- Delete a document. Parameter is a document ID.
297
+ ```js
298
+ // Without params
299
+
300
+ client
301
+ .delete({ query: '*[_type == "bike"][0]' })
302
+ .then(() => {
303
+ console.log('The document matching *[_type == "bike"][0] was deleted')
304
+ })
305
+ .catch((err) => {
306
+ console.error('Delete failed: ', err.message)
307
+ })
308
+ ```
309
+
310
+ ```js
311
+ // With params
312
+
313
+ client
314
+ .delete({ query: '*[_type == $type][0..1]', params: { type: 'bike' } })
315
+ .then(() => {
316
+ console.log('The documents matching *[_type == "bike"][0..1] was deleted')
317
+ })
318
+ .catch((err) => {
319
+ console.error('Delete failed: ', err.message)
320
+ })
321
+ ```
292
322
 
293
323
  ### Multiple mutations in a transaction
294
324
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sanity/client",
3
- "version": "2.23.2-next.3+4c7c1788c7",
3
+ "version": "2.23.2",
4
4
  "description": "Client for retrieving data from Sanity",
5
5
  "main": "lib/sanityClient.js",
6
6
  "umd": "umd/sanityClient.min.js",
@@ -22,8 +22,8 @@
22
22
  "./lib/http/nodeMiddleware.js": "./lib/http/browserMiddleware.js"
23
23
  },
24
24
  "dependencies": {
25
- "@sanity/eventsource": "2.23.2-next.3+4c7c1788c7",
26
- "@sanity/generate-help-url": "2.23.2-next.3+4c7c1788c7",
25
+ "@sanity/eventsource": "2.23.0",
26
+ "@sanity/generate-help-url": "2.18.0",
27
27
  "@sanity/observable": "2.0.9",
28
28
  "deep-assign": "^2.0.0",
29
29
  "get-it": "^5.2.1",
@@ -83,5 +83,5 @@
83
83
  ],
84
84
  "sourceMap": false
85
85
  },
86
- "gitHead": "4c7c1788c7e196d4a4b7eb2b136f71a328fbadef"
86
+ "gitHead": "4d49b83a987d5097064d567f75d21b268a410cbf"
87
87
  }