screenshotone-api-sdk - npm Package Compare versions

Comparing version 1.1.12 to 1.1.13

dist/@types/main.d.ts

@@ -85,3 +85,3 @@ /**
      * by_format — return exactly the response defined in the format option. If format=png, the response will be the binary representation of the png with the content type header image/png;
-     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don’t care about the results. It also speeds up the response since there are no networking costs involved.
+     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don't care about the results. It also speeds up the response since there are no networking costs involved.
      * The default value is by_format.
@@ -113,3 +113,3 @@ */
      * Set `false` to request site rendering in the light mode if supported.
-     * If you don’t set the parameter. The site is rendered in the default mode.
+     * If you don't set the parameter. The site is rendered in the default mode.
      */
@@ -304,3 +304,3 @@ darkMode(darkMode: boolean): TakeOptions;
     /**
-     * After the given element appears in the viewport and its top coordinate is aligned with the viewport’s top,
+     * After the given element appears in the viewport and its top coordinate is aligned with the viewport's top,
      * you can adjust the position a bit before taking a screenshot.
@@ -351,5 +351,5 @@ */
      * The parameter is required if you set store=true.
-     * You must specify the key for the file, but don’t specify an extension,
+     * You must specify the key for the file, but don't specify an extension,
      * it will be added automatically based on the format you specified.
-     * You can also specify “subdirectories” in the path part.
+     * You can also specify "subdirectories" in the path part.
      */
@@ -398,3 +398,3 @@ storagePath(path: string): TakeOptions;
      * by_format — return exactly the response defined in the format option. If format=png, the response will be the binary representation of the png with the content type header image/png;
-     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don’t care about the results. It also speeds up the response since there are no networking costs involved.
+     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don't care about the results. It also speeds up the response since there are no networking costs involved.
      * The default value is by_format.
@@ -418,3 +418,3 @@ */
      * Set `false` to request site rendering in the light mode if supported.
-     * If you don’t set the parameter. The site is rendered in the default mode.
+     * If you don't set the parameter. The site is rendered in the default mode.
      */
@@ -599,5 +599,5 @@ darkMode(darkMode: boolean): AnimateOptions;
      * The parameter is required if you set store=true.
-     * You must specify the key for the file, but don’t specify an extension,
+     * You must specify the key for the file, but don't specify an extension,
      * it will be added automatically based on the format you specified.
-     * You can also specify “subdirectories” in the path part.
+     * You can also specify "subdirectories" in the path part.
      */
@@ -630,3 +630,13 @@ storagePath(path: string): AnimateOptions;
     scrollBy(pixels: number): AnimateOptions;
+    /**
+     * When the site responds out of the range of 200-299 status code,
+     * you can ignore errors and take a screenshot of the error page anyway.
+     * To do that, set the option "ignore_host_errors" to true.
+     * It is false by default.
+     *
+     * It is helpful when you want to create a gallery of error pages or,
+     * for some reason, you need to render error pages.
+     */
+    ignoreHostErrors(ignore: boolean): AnimateOptions;
     toQuery(): URLSearchParams;
 }

dist/main.js

@@ -199,3 +199,3 @@ "use strict";
      * by_format — return exactly the response defined in the format option. If format=png, the response will be the binary representation of the png with the content type header image/png;
-     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don’t care about the results. It also speeds up the response since there are no networking costs involved.
+     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don't care about the results. It also speeds up the response since there are no networking costs involved.
      * The default value is by_format.
@@ -242,3 +242,3 @@ */
      * Set `false` to request site rendering in the light mode if supported.
-     * If you don’t set the parameter. The site is rendered in the default mode.
+     * If you don't set the parameter. The site is rendered in the default mode.
      */
@@ -553,3 +553,3 @@ darkMode(darkMode) {
     /**
-     * After the given element appears in the viewport and its top coordinate is aligned with the viewport’s top,
+     * After the given element appears in the viewport and its top coordinate is aligned with the viewport's top,
      * you can adjust the position a bit before taking a screenshot.
@@ -627,5 +627,5 @@ */
      * The parameter is required if you set store=true.
-     * You must specify the key for the file, but don’t specify an extension,
+     * You must specify the key for the file, but don't specify an extension,
      * it will be added automatically based on the format you specified.
-     * You can also specify “subdirectories” in the path part.
+     * You can also specify "subdirectories" in the path part.
      */
@@ -718,3 +718,3 @@ storagePath(path) {
      * by_format — return exactly the response defined in the format option. If format=png, the response will be the binary representation of the png with the content type header image/png;
-     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don’t care about the results. It also speeds up the response since there are no networking costs involved.
+     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don't care about the results. It also speeds up the response since there are no networking costs involved.
      * The default value is by_format.
@@ -747,3 +747,3 @@ */
      * Set `false` to request site rendering in the light mode if supported.
-     * If you don’t set the parameter. The site is rendered in the default mode.
+     * If you don't set the parameter. The site is rendered in the default mode.
      */
@@ -1045,5 +1045,5 @@ darkMode(darkMode) {
      * The parameter is required if you set store=true.
-     * You must specify the key for the file, but don’t specify an extension,
+     * You must specify the key for the file, but don't specify an extension,
      * it will be added automatically based on the format you specified.
-     * You can also specify “subdirectories” in the path part.
+     * You can also specify "subdirectories" in the path part.
      */
@@ -1118,2 +1118,15 @@ storagePath(path) {
     }
+    /**
+     * When the site responds out of the range of 200-299 status code,
+     * you can ignore errors and take a screenshot of the error page anyway.
+     * To do that, set the option "ignore_host_errors" to true.
+     * It is false by default.
+     *
+     * It is helpful when you want to create a gallery of error pages or,
+     * for some reason, you need to render error pages.
+     */
+    ignoreHostErrors(ignore) {
+        this.put("ignore_host_errors", ignore ? "true" : "false");
+        return this;
+    }
     toQuery() {
@@ -1120,0 +1133,0 @@ return new URLSearchParams(this.query.toString());

package.json

 {
   "name": "screenshotone-api-sdk",
   "homepage": "https://screenshotone.com",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "Use ScreenshotOne.com API to generate screenshots of any website.",
@@ -6,0 +6,0 @@ "repository": {

src/main.ts

@@ -251,3 +251,3 @@ import Big from "big.js";
      * by_format — return exactly the response defined in the format option. If format=png, the response will be the binary representation of the png with the content type header image/png;
-     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don’t care about the results. It also speeds up the response since there are no networking costs involved.
+     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don't care about the results. It also speeds up the response since there are no networking costs involved.
      * The default value is by_format.
@@ -304,3 +304,3 @@ */
      * Set `false` to request site rendering in the light mode if supported.
-     * If you don’t set the parameter. The site is rendered in the default mode.
+     * If you don't set the parameter. The site is rendered in the default mode.
      */
@@ -701,3 +701,3 @@ darkMode(darkMode: boolean): TakeOptions {
     /**
-     * After the given element appears in the viewport and its top coordinate is aligned with the viewport’s top,
+     * After the given element appears in the viewport and its top coordinate is aligned with the viewport's top,
      * you can adjust the position a bit before taking a screenshot.
@@ -793,5 +793,5 @@ */
      * The parameter is required if you set store=true.
-     * You must specify the key for the file, but don’t specify an extension,
+     * You must specify the key for the file, but don't specify an extension,
      * it will be added automatically based on the format you specified.
-     * You can also specify “subdirectories” in the path part.
+     * You can also specify "subdirectories" in the path part.
      */
@@ -906,3 +906,3 @@ storagePath(path: string): TakeOptions {
      * by_format — return exactly the response defined in the format option. If format=png, the response will be the binary representation of the png with the content type header image/png;
-     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don’t care about the results. It also speeds up the response since there are no networking costs involved.
+     * empty — return only status or error. It is suitable when you want to upload the screenshot to storage and don't care about the results. It also speeds up the response since there are no networking costs involved.
      * The default value is by_format.
@@ -941,3 +941,3 @@ */
      * Set `false` to request site rendering in the light mode if supported.
-     * If you don’t set the parameter. The site is rendered in the default mode.
+     * If you don't set the parameter. The site is rendered in the default mode.
      */
@@ -1323,5 +1323,5 @@ darkMode(darkMode: boolean): AnimateOptions {
      * The parameter is required if you set store=true.
-     * You must specify the key for the file, but don’t specify an extension,
+     * You must specify the key for the file, but don't specify an extension,
      * it will be added automatically based on the format you specified.
-     * You can also specify “subdirectories” in the path part.
+     * You can also specify "subdirectories" in the path part.
      */
@@ -1425,2 +1425,17 @@ storagePath(path: string): AnimateOptions {
 
+    /**
+     * When the site responds out of the range of 200-299 status code,
+     * you can ignore errors and take a screenshot of the error page anyway.
+     * To do that, set the option "ignore_host_errors" to true.
+     * It is false by default.
+     *
+     * It is helpful when you want to create a gallery of error pages or,
+     * for some reason, you need to render error pages.
+     */
+    ignoreHostErrors(ignore: boolean): AnimateOptions {
+        this.put("ignore_host_errors", ignore ? "true" : "false");
+
+        return this;
+    }
+
     toQuery(): URLSearchParams {
@@ -1427,0 +1442,0 @@ return new URLSearchParams(this.query.toString());

No alert changes

Improved metrics

Total package byte prevSize

111351

increased by1.32%

Lines of code

3037

increased by1.2%

No dependency changes