563/async-example-readme

CHANGELOG.md

@@ -11,17 +11,16 @@ _Fixes:_
 - Fixed an issue where the chart constructor was sometimes incorrectly set, causing the export to fail
 - Added referrers to CDN cache fetches on first startup/install. 
 - Fixed an issue that would sometimes cause cause a crash due to fail due to `Accept-Ranges` headers
+-  Corrected the `Node.js Module` example in the README.
 - Fixed the warning message when the the default `resources.json` file is not found.
 - Fixed the problem with the lack of the `instr` value, when the `options` is set instead
 
 _New Features:_
 
 - Added proxy authentication [(#631)](https://github.com/highcharts/node-export-server/issues/631).
-
-_New features:_
-
 - Made the temporary Puppeteer directory (`PUPPETEER_TEMP_DIR`) (till now, `'./tmp'`) configurable by the user [(#567)](https://github.com/highcharts/node-export-server/issues/567).
 
+
 # 4.0.2
 
 _Hotfix_:

README.md

@@ -584,20 +584,23 @@ const options = {
   }
 };
 
-// Initialize export settings with your chart's config
-const exportSettings = exporter.setOptions(options);
-
-// Must initialize exporting before being able to export charts
-await exporter.initExport(exportSettings);
-
-// Perform an export
-await exporter.startExport(exportSettings, async (error, info) => {
-  // The export result is now in info
-  // It will be base64 encoded (info.data)
-
-  // Kill the pool when we are done with it
-  await exporter.killPool();
-});
+// Logic must be triggered in an asynchronous function
+(async () => {
+  // Initialize export settings with your chart's config
+  const exportSettings = exporter.setOptions(options);
+
+  // Must initialize exporting before being able to export charts
+  await exporter.initExport(exportSettings);
+
+  // Perform an export
+  await exporter.startExport(exportSettings, async (error, info) => {
+    // The export result is now in info
+    // It will be base64 encoded (info.result)
+
+    // Kill the pool when we are done with it
+    await exporter.killPool();
+  });
+})();
 ```
 
 ## CommonJS support