From f455ec17eb77dbadfc7719c3ec456384edd6b4a2 Mon Sep 17 00:00:00 2001
From: Will Dickinson <will@zonos.com>
Date: Fri, 12 Aug 2022 13:09:49 -0600
Subject: [PATCH] storyshots-puppeteer: add browserLaunchOptions to
 documentation

---
 .../storyshots/storyshots-puppeteer/README.md | 20 +++++++++++++++++++
 .../storyshots-puppeteer/src/config.ts        |  4 ++++
 2 files changed, 24 insertions(+)

diff --git a/code/addons/storyshots/storyshots-puppeteer/README.md b/code/addons/storyshots/storyshots-puppeteer/README.md
index b9e4567ab04..fb1c250b283 100644
--- a/code/addons/storyshots/storyshots-puppeteer/README.md
+++ b/code/addons/storyshots/storyshots-puppeteer/README.md
@@ -107,6 +107,26 @@ initStoryshots({
 });
 ```
 
+### Customizing browser launch options (Puppeteer API)
+
+You might use the `browserLaunchOptions` to specify options for the default browser instance. Will be passed to [puppeteer.launch()](https://pptr.dev/api/puppeteer.puppeteernode.launch)
+
+```js
+import initStoryshots from '@storybook/addon-storyshots';
+import { puppeteerTest } from '@storybook/addon-storyshots-puppeteer';
+
+initStoryshots({
+  suite: 'Puppeteer storyshots',
+  test: puppeteerTest({
+    storybookUrl: 'https://some-local-ssl-url:7777',
+    browserLaunchOptions: {
+      // For ignoring self-signed certificates
+      ignoreHTTPSErrors: true,
+    },
+  }),
+});
+```
+
 ### Specifying custom Chrome executable path (Puppeteer API)
 
 You might use `chromeExecutablePath` to specify the path to a different version of Chrome, without downloading Chromium. Will be passed to [Runs a bundled version of Chromium](https://github.com/GoogleChrome/puppeteer#default-runtime-settings)
diff --git a/code/addons/storyshots/storyshots-puppeteer/src/config.ts b/code/addons/storyshots/storyshots-puppeteer/src/config.ts
index f7a59253788..e5b626f91a0 100644
--- a/code/addons/storyshots/storyshots-puppeteer/src/config.ts
+++ b/code/addons/storyshots/storyshots-puppeteer/src/config.ts
@@ -32,6 +32,10 @@ export interface CommonConfig {
   getGotoOptions: (options: Options) => DirectNavigationOptions;
   customizePage: (page: Page) => Promise<void>;
   getCustomBrowser: () => Promise<Browser>;
+  /**
+   * Puppeteer browser launch options:
+   * {@link https://pptr.dev/api/puppeteer.puppeteernode.launch/ puppeteer.launch()}
+   */
   browserLaunchOptions: LaunchOptions;
   setupTimeout: number;
   testTimeout: number;