Skip to content

Commit e6d8543

Browse files
committed
move render when ready to parameters section
1 parent 3705a10 commit e6d8543

File tree

3 files changed

+8
-28
lines changed

3 files changed

+8
-28
lines changed

getting-started/using-the-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Optional parameters for greater control over your image.
6262
| **selector** | `String` | A [CSS selector](/guides/selector/) for an element on the webpage. We'll crop the image to this specific element. For example: `section#complete-toolkit.container-lg` |
6363
| **ms_delay** | `Integer` | The number of milliseconds the API should delay before generating the image. This is useful when waiting for JavaScript. We recommend starting with `500`. Large values slow down the initial render time. [Learn more](/parameters/ms_delay/). |
6464
| **device_scale** | `Double` | This adjusts the pixel ratio for the screenshot. Minimum: `1`, Maximum: `3`. [Learn more](/parameters/device_scale/). |
65-
| **render_when_ready** | `Boolean` | Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](/guides/render-when-ready/). |
65+
| **render_when_ready** | `Boolean` | Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](/parameters/render_when_ready/). |
6666
| **full_screen** | `Boolean` | When set to true, the API will generate an image of the entire height of the page. |
6767
| **viewport_width** | `Integer` | Set the width of Chrome's viewport. This will disable automatic cropping. Both height and width parameters must be set if using either. |
6868
| **viewport_height** | `Integer` | Set the height of Chrome's viewport. This will disable automatic cropping. Both height and width parameters must be set if using either. |
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
layout: page
33
title: Render when ready
4-
permalink: /guides/render-when-ready/
5-
parent: Guides
4+
permalink: /parameters/render-when-ready/
5+
parent: Parameters
66
nav_order: 8
77
description: >-
88
Control when your image is generated by using the render_when_ready parameter.

workers-site/index.js

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -29,73 +29,53 @@ async function redirectOrHandleEvent(event) {
2929
var path = url.pathname.replace(/\/$/, "");
3030
var site = "https://docs.htmlcsstoimage.com";
3131

32-
switch(path) {
32+
switch (path) {
3333
case "/getting-started/creating-an-image":
3434
return Response.redirect(site + '/getting-started/using-the-api/', 301);
35-
break;
35+
case "/guies/render-when-reader":
36+
return Response.redirect(site + '/parameters/render_when_ready', 301);
3637
case "/getting-started/deleting-an-image":
3738
return Response.redirect(site + '/getting-started/using-the-api/', 301);
38-
break;
3939
case "/getting-started/retrieving-an-image":
4040
return Response.redirect(site + '/getting-started/using-the-api/', 301);
41-
break;
4241
case "/getting-started/authentication":
4342
return Response.redirect(site + '/getting-started/using-the-api/', 301);
44-
break;
4543
case "/getting-started/full-page-images":
4644
return Response.redirect(site + '/getting-started/convert-emails-images/', 301);
47-
break;
4845
case "/getting-started/duplicate-image-detection":
4946
return Response.redirect(site + '/guides/duplicate-image-detection/', 301);
50-
break;
5147
case "/getting-started/faq":
5248
return Response.redirect(site + '/faq', 301);
53-
break;
5449
case "/advanced-examples/using-google-fonts":
5550
return Response.redirect(site + '/guides/using-google-fonts', 301);
56-
break;
5751
case "/advanced-examples/rendering-emoji":
5852
return Response.redirect(site + '/guides/rendering-emoji', 301);
59-
break;
6053
case "/advanced-examples/image-charts-with-highcharts":
6154
return Response.redirect(site + '/guides/image-charts-with-highchartsjs', 301);
62-
break;
6355
case "/advanced-examples/transparent-background":
6456
return Response.redirect(site + '/guides/transparent-background', 301);
65-
break;
6657
case "/advanced-examples/external-css-and-fonts":
6758
return Response.redirect(site + '/guides/external-css-js-and-fonts/', 301);
68-
break;
6959
case "/getting-started/lossless-image-optimization":
7060
return Response.redirect(site + '/getting-started/file-formats', 301);
71-
break;
7261
case "/advanced-examples/instagram-embed":
7362
return Response.redirect(site + '/guides/instagram-embed/', 301);
74-
break;
7563
case "/advanced-examples/twitter-embed":
7664
return Response.redirect(site + '/guides/twitter-embed/', 301);
77-
break;
7865
case "/getting-started/integromat-integration":
7966
return Response.redirect(site + '/integrations/integromat/', 301);
80-
break;
8167
case "/integrations/integromat":
8268
return Response.redirect(site + '/integrations/make/', 301);
83-
break;
8469
case "/getting-started/zapier-integration":
8570
return Response.redirect(site + '/integrations/zapier/', 301);
86-
break;
8771
case "/getting-started/convert-emails-images":
8872
return Response.redirect(site + '/guides/convert-emails-images/', 301);
89-
break;
9073
case "/getting-started/file-formats":
9174
return Response.redirect(site + '/guides/file-formats/', 301);
92-
break;
9375
case "/guides/twitter-embed":
9476
return Response.redirect(site + '/guides/twitter-screenshot/', 301);
95-
break;
9677
default:
9778
return await handleEvent(event);
98-
break;
9979
}
10080
}
10181

@@ -106,7 +86,7 @@ async function handleEvent(event) {
10686

10787
if (event.request.url.match(/\.js$/) || event.request.url.match(/\.css$/) || event.request.url.match(/\.png$/)) {
10888
cacheControl = {
109-
browserTTL: 365* 60 * 60 * 24,
89+
browserTTL: 365 * 60 * 60 * 24,
11090
edgeTTL: 30 * 60 * 60 * 24,
11191
bypassCache: false, // do not bypass Cloudflare's cache
11292
}
@@ -155,7 +135,7 @@ async function handleEvent(event) {
155135
})
156136

157137
return new Response(notFoundResponse.body, { ...notFoundResponse, status: 404 })
158-
} catch (e) {}
138+
} catch (e) { }
159139
}
160140

161141
return new Response(e.message || e.toString(), { status: 500 })

0 commit comments

Comments
 (0)