Return canvas element from toCanvas()

Author: metafloor

README.md

@@ -24,7 +24,7 @@ found at the end of this document.
 
 ## Status 
 
-* Current bwip-js version is 2.0.1 (2019-12-13)
+* Current bwip-js version is 2.0.2 (2019-12-14)
 * Current BWIPP version is 2019-11-08
 * Node.js compatibility: 0.12+
 * Browser compatibility: Edge, Firefox, Chrome
@@ -154,14 +154,15 @@ The script adds a single `bwipjs` global object.  To draw a barcode to a canvas:
 
 ```javascript
 try {
-  bwipjs.toCanvas('mycanvas', {
-        bcid:        'code128',       // Barcode type
-        text:        '0123456789',    // Text to encode
-        scale:       3,               // 3x scaling factor
-        height:      10,              // Bar height, in millimeters
-        includetext: true,            // Show human-readable text
-        textxalign:  'center',        // Always good to set this
-    });
+    // The return value is the canvas element
+    let canvas = bwipjs.toCanvas('mycanvas', {
+            bcid:        'code128',       // Barcode type
+            text:        '0123456789',    // Text to encode
+            scale:       3,               // 3x scaling factor
+            height:      10,              // Bar height, in millimeters
+            includetext: true,            // Show human-readable text
+            textxalign:  'center',        // Always good to set this
+        });
 } catch (e) {
     // `e` may be a string or Error object
 }
@@ -205,14 +206,15 @@ import bwipjs from 'bwip-js';
 class App extends Component {
   componentDidMount() {
     try {
-      bwipjs.toCanvas('mycanvas', {
-            bcid:        'code128',       // Barcode type
-            text:        '0123456789',    // Text to encode
-            scale:       3,               // 3x scaling factor
-            height:      10,              // Bar height, in millimeters
-            includetext: true,            // Show human-readable text
-            textxalign:  'center',        // Always good to set this
-        });
+      // The return value is the canvas element
+      let canvas = bwipjs.toCanvas('mycanvas', {
+                bcid:        'code128',       // Barcode type
+                text:        '0123456789',    // Text to encode
+                scale:       3,               // 3x scaling factor
+                height:      10,              // Bar height, in millimeters
+                includetext: true,            // Show human-readable text
+                textxalign:  'center',        // Always good to set this
+            });
     } catch (e) {
         // `e` may be a string or Error object
     }

dist/bwip-js-min.js

@@ -120,6 +120,8 @@ function ToBuffer(opts, callback) {
 //
 // This function is synchronous and throws on error.
 //
+// Returns the HTMLCanvasElement.
+//
 // Browser usage only.
 function ToCanvas(opts, canvas) {
 	if (typeof canvas == 'string') {
@@ -136,6 +138,8 @@ function ToCanvas(opts, canvas) {
 	}
 	FixupOptions(opts);
 	Render(opts, DrawingCanvas(opts, canvas));
+
+	return canvas;
 }
 
 // bwipjs.fixupOptions(options)
@@ -253,7 +257,7 @@ function Render(params, drawing) {
 
 	// Call into the BWIPP cross-compiled code and render the image.
 	BWIPP()(bw, bcid, text, opts);
-	return bw.render();		// Returns whatever drawing.end() returns
+	return bw.render();		// Return whatever drawing.end() returns
 }
 
 // bwipjs.raw(options)
@@ -36472,7 +36476,7 @@ return {
 		request:Request, toBuffer:ToBuffer, toCanvas:ToCanvas, render:Render, raw:Raw,
 		fixupOptions:FixupOptions,
 		loadFont:FontLib.loadFont,
-		VERSION:'2.0.1 (2019-12-13)',
+		VERSION:'2.0.2 (2019-12-14)',
 
 		// Internals
 		BWIPJS:BWIPJS, BWIPP:BWIPP, STBTT:STBTT, FontLib:FontLib,

dist/bwip-js.js

@@ -1,6 +1,6 @@
 {
   "name": "bwip-js",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "JavaScript barcode generator supporting over 90 types and standards.",
   "main": "./dist/bwip-js.js",
   "bin": {

package.json

@@ -80,6 +80,8 @@ function ToBuffer(opts, callback) {
 //
 // This function is synchronous and throws on error.
 //
+// Returns the HTMLCanvasElement.
+//
 // Browser usage only.
 function ToCanvas(opts, canvas) {
 	if (typeof canvas == 'string') {
@@ -96,6 +98,8 @@ function ToCanvas(opts, canvas) {
 	}
 	FixupOptions(opts);
 	Render(opts, DrawingCanvas(opts, canvas));
+
+	return canvas;
 }
 
 // bwipjs.fixupOptions(options)