add svgOptions checks + tests

Author: g-harel

README.md

@@ -3,12 +3,12 @@
 </p>
 
 <p align="center">
-    <a href="https://www.npmjs.com/package/blobs">
-        <img src="https://img.shields.io/npm/v/blobs.svg">
-    </a>
-    <a href="https://github.com/g-harel/blobs/actions?query=workflow%3Aon-push">
-        <img src="https://img.shields.io/github/workflow/status/g-harel/blobs/on-push">
-    </a>
+    <a href="https://www.npmjs.com/package/blobs"><!--
+     --><img src="https://img.shields.io/npm/v/blobs.svg"><!--
+ --></a>
+    <a href="https://github.com/g-harel/blobs/actions?query=workflow%3Aon-push"><!--
+     --><img src="https://img.shields.io/github/workflow/status/g-harel/blobs/on-push"><!--
+ --></a>
 </p>
 
 <p align="center">
@@ -19,8 +19,11 @@
 
 ## Install
 
+```bash
+$ npm install blobs
+```
+
 ```ts
-// $ npm install blobs
 import * as blobs2 from "blobs/v2";
 ```
 

index.html

@@ -66,12 +66,18 @@
                 if (!mobileElem) return;
                 console.log(window.innerWidth);
 
-                mobileElem.innerHTML = blobs2.svg({
-                    seed: Math.random(),
-                    extraPoints: 4,
-                    randomness: 6,
-                    size: Math.min(600, window.innerWidth - 100),
-                });
+                mobileElem.innerHTML = blobs2.svg(
+                    {
+                        seed: Math.random(),
+                        extraPoints: 4,
+                        randomness: 6,
+                        size: Math.min(600, window.innerWidth - 100),
+                    },
+                    {
+                        stroke: "black",
+                        strokeWidth: -10,
+                    },
+                );
             }
 
             refresh();

internal/check.ts

@@ -45,4 +45,10 @@ export const checkCanvasOptions = (canvasOptions: any) => {
 
 export const checkSvgOptions = (svgOptions: any) => {
     typeCheck(`svgOptions`, svgOptions, ["object", "undefined"]);
+    if (svgOptions) {
+        const {fill, stroke, strokeWidth} = svgOptions;
+        typeCheck(`svgOptions.fill`, fill, ["string", "undefined"]);
+        typeCheck(`svgOptions.stroke`, stroke, ["string", "undefined"]);
+        typeCheck(`svgOptions.strokeWidth`, strokeWidth, ["number", "undefined"]);
+    }
 };

public/blobs.test.ts

@@ -219,6 +219,54 @@ describe("blobs", () => {
                     /svgOptions.*object.*null/g,
                 );
             });
+
+            runSuite<SvgOptions>({
+                functionBeingTested: (svgOptions) => svg(genBlobOptions(), svgOptions),
+                optionsGenerator: genSvgOptions,
+            })([
+                // fill
+                {
+                    name: "should accept valid svgOptions fill",
+                    edit: (svgOptions) => (svgOptions.fill = "red"),
+                },
+                {
+                    name: "should accept undefined svgOptions fill",
+                    edit: (svgOptions) => delete svgOptions?.fill,
+                },
+                {
+                    name: "should reject broken svgOptions fill",
+                    edit: (svgOptions) => (svgOptions.fill = null as any),
+                    error: /svgOptions.*fill.*string.*null/g,
+                },
+                // stroke
+                {
+                    name: "should accept valid svgOptions stroke",
+                    edit: (svgOptions) => (svgOptions.stroke = "red"),
+                },
+                {
+                    name: "should accept undefined svgOptions stroke",
+                    edit: (svgOptions) => delete svgOptions?.stroke,
+                },
+                {
+                    name: "should reject broken svgOptions stroke",
+                    edit: (svgOptions) => (svgOptions.stroke = null as any),
+                    error: /svgOptions.*stroke.*string.*null/g,
+                },
+                // strokeWidth
+                {
+                    name: "should accept valid svgOptions strokeWidth",
+                    edit: (svgOptions) => (svgOptions.strokeWidth = 222),
+                },
+                {
+                    name: "should accept undefined svgOptions strokeWidth",
+                    edit: (svgOptions) => delete svgOptions?.strokeWidth,
+                },
+                {
+                    name: "should reject broken svgOptions strokeWidth",
+                    edit: (svgOptions) => (svgOptions.strokeWidth = NaN),
+                    error: /svgOptions.*strokeWidth.*number.*NaN/g,
+                },
+            ]);
         });
     });