😘

index.js

@@ -26,11 +26,11 @@ const injectLottie = `
  *
  * You must pass either `path` or `animationData` to specify the Lottie animation.
  *
- * `output` may be any of the following:
- *   - an image to capture the first frame only (png or jpg)
- *   - an image pattern (eg. sprintf format 'frame-%d.png' or 'frame-%012d.jpg')
- *   - an mp4 video file (requires FFmpeg to be installed)
- *   - a GIF file (requires Gifski to be installed)
+ * `output` must be one of the following:
+ *   - An image to capture the first frame only (png or jpg)
+ *   - An image pattern (eg. sprintf format 'frame-%d.png' or 'frame-%012d.jpg')
+ *   - An mp4 video file (requires FFmpeg to be installed)
+ *   - A GIF file (requires Gifski to be installed)
  *
  * @name renderLottie
  * @function
@@ -344,7 +344,7 @@ ${inject.body || ''}
     await ffmpegP
 
     if (spinnerF) {
-      spinnerF.success()
+      spinnerF.succeed()
     }
   } else if (isGif) {
     const spinnerG = !quiet && ora(`Generating GIF with Gifski`).start()
@@ -367,7 +367,7 @@ ${inject.body || ''}
     await execa.shell(cmd)
 
     if (spinnerG) {
-      spinnerG.success()
+      spinnerG.succeed()
     }
   }
 

package.json

@@ -31,7 +31,6 @@
   "devDependencies": {
     "ava": "^1.4.1",
     "ffmpeg-probe": "^1.0.6",
-    "rmfr": "^2.0.0",
     "sharp": "^0.22.1",
     "standard": "^12.0.1",
     "update-markdown-jsdoc": "^1.0.6"

readme.md

@@ -74,18 +74,18 @@ For `mp4` outputs, the height may be different by a pixel due to the `x264` enco
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### [renderLottie](https://[email protected]/:transitive-bullshit/puppeteer-lottie/blob/56235fed59f7a84656f0e8508275cdfc73396dfb/index.js#L60-L382)
+### [renderLottie](https://[email protected]/:transitive-bullshit/puppeteer-lottie/blob/42f179e03af2529164dc0e45dbc0b0417331dd82/index.js#L60-L382)
 
 Renders the given Lottie animation via Puppeteer.
 
-Must pass either `path` or `animationData`.
+You must pass either `path` or `animationData` to specify the Lottie animation.
 
-`output` may be any of the following:
+`output` must be one of the following:
 
--   an image to capture the first frame only (png or jpg)
--   an image pattern (eg. sprintf format 'frame-%d.png' or 'frame-%012d.jpg')
--   an mp4 video file (requires FFmpeg to be installed)
--   a GIF file (requires Gifski to be installed)
+-   An image to capture the first frame only (png or jpg)
+-   An image pattern (eg. sprintf format 'frame-%d.png' or 'frame-%012d.jpg')
+-   An mp4 video file (requires FFmpeg to be installed)
+-   A GIF file (requires Gifski to be installed)
 
 Type: `function (opts): Promise`