From 4b38f56d0205a6991fe900da9291cc0175cb8419 Mon Sep 17 00:00:00 2001
From: Lovell Fuller <github@lovell.info>
Date: Thu, 1 Sep 2022 09:57:50 +0100
Subject: [PATCH] Docs: add avif and heif examples

---
 docs/api-output.md | 24 +++++++++++++++++++++---
 lib/output.js      | 17 ++++++++++++++++-
 2 files changed, 37 insertions(+), 4 deletions(-)

diff --git a/docs/api-output.md b/docs/api-output.md
index ec6d7af4..743009d1 100644
--- a/docs/api-output.md
+++ b/docs/api-output.md
@@ -472,7 +472,19 @@ AVIF image sequences are not supported.
     *   `options.effort` **[number][12]** CPU effort, between 0 (fastest) and 9 (slowest) (optional, default `4`)
     *   `options.chromaSubsampling` **[string][2]** set to '4:2:0' to use chroma subsampling (optional, default `'4:4:4'`)
 
-<!---->
+### Examples
+
+```javascript
+const data = await sharp(input)
+  .avif({ effort: 2 })
+  .toBuffer();
+```
+
+```javascript
+const data = await sharp(input)
+  .avif({ lossless: true })
+  .toBuffer();
+```
 
 *   Throws **[Error][4]** Invalid options
 
@@ -486,7 +498,7 @@ Returns **Sharp**&#x20;
 
 Use these HEIF options for output image.
 
-Support for patent-encumbered HEIC images requires the use of a
+Support for patent-encumbered HEIC images using `hevc` compression requires the use of a
 globally-installed libvips compiled with support for libheif, libde265 and x265.
 
 ### Parameters
@@ -499,7 +511,13 @@ globally-installed libvips compiled with support for libheif, libde265 and x265.
     *   `options.effort` **[number][12]** CPU effort, between 0 (fastest) and 9 (slowest) (optional, default `4`)
     *   `options.chromaSubsampling` **[string][2]** set to '4:2:0' to use chroma subsampling (optional, default `'4:4:4'`)
 
-<!---->
+### Examples
+
+```javascript
+const data = await sharp(input)
+  .heif({ compression: 'hevc' })
+  .toBuffer();
+```
 
 *   Throws **[Error][4]** Invalid options
 
diff --git a/lib/output.js b/lib/output.js
index 338c9a04..9a3c64b7 100644
--- a/lib/output.js
+++ b/lib/output.js
@@ -825,6 +825,16 @@ function tiff (options) {
  *
  * AVIF image sequences are not supported.
  *
+ * @example
+ * const data = await sharp(input)
+ *   .avif({ effort: 2 })
+ *   .toBuffer();
+ *
+ * @example
+ * const data = await sharp(input)
+ *   .avif({ lossless: true })
+ *   .toBuffer();
+ *
  * @since 0.27.0
  *
  * @param {Object} [options] - output options
@@ -842,9 +852,14 @@ function avif (options) {
 /**
  * Use these HEIF options for output image.
  *
- * Support for patent-encumbered HEIC images requires the use of a
+ * Support for patent-encumbered HEIC images using `hevc` compression requires the use of a
  * globally-installed libvips compiled with support for libheif, libde265 and x265.
  *
+ * @example
+ * const data = await sharp(input)
+ *   .heif({ compression: 'hevc' })
+ *   .toBuffer();
+ *
  * @since 0.23.0
  *
  * @param {Object} [options] - output options