@beauraines/node-helpers 4.1.1 → 4.2.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [4.2.0](https://github.com/beauraines/node-helpers/compare/v4.1.1...v4.2.0) (2024-10-06)
+
+
+### Features
+
+* **sparkline:** option support for range coercion ([053b14d](https://github.com/beauraines/node-helpers/commit/053b14d1c7334691ea0ab97b3c24f719d05aeda0))
+* **sparkline:** optionally make a sparkline wiht out the label and descriptive stats ([379330c](https://github.com/beauraines/node-helpers/commit/379330c4f8fb8723b500f65de5a6ed247485d81f))
+
 ### [4.1.1](https://github.com/beauraines/node-helpers/compare/v4.1.0...v4.1.1) (2024-10-05)
 
 ## [4.1.0](https://github.com/beauraines/node-helpers/compare/v4.0.39...v4.1.0) (2024-10-05)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Collection of node helpers",
   "main": "index.js",
   "repository": {

package/src/helpers.js

@@ -107,32 +107,58 @@ function getEpochMillis() {
 }
 
 
-// TODO Add unit test
-// Expected output last 30 days [1,5] ▁▂▄▆█ 5 from [1,2,3,4,5]
+
 /**
- * Generates a sparkline with labels
+ * Generates a sparkline optionally with labels
+ * 
+ * labelled sparkline includes a label, min, max and last value
+ *
+ * last 30 days [1,5] ▁▂▄▆█ 5
+ * 
+ * unlabled is just that ▁▂▄▆█
+ * 
+ * Options supported are
+ * 
+ * {
+ * coerceData: true, // coerces the minimum value to zero 
+ * }
  * 
  * @param {array} data Array of values to plot in the sparkline
- * @param {string} label Text to display before sparkline
+ * @param {string} label Text to display before sparkline, if empty or null, will not display any labels
  * @param {object} options Optional options for display, e.g display min,max,last, range coercion
+ * 
  * @returns 
  */
 // eslint-disable-next-line no-unused-vars
 function sparkline(data,label,options) {
-  // TODO add handling if data is object
-  // let open = last30days.map( x=> x.open_count)
 
+  options = {
+    coerceData: true,
+    ...options
+  }
+
+  // TODO add handling if data is object
   // Assuming data is array
   const minValue = Math.min(...data)
   const maxValue = Math.max(...data)
   const lastValue = data.slice(-1)[0]
 
-  // coerces the minimum value to zero because the mimimum option is only used for range validation, 
-  // not display https://github.com/sindresorhus/sparkly/blob/9e33eaff891c41e8fb8c8883f62e9821729a9882/index.js#L15
-  // sparkly(open,{minimum:27,maximum:50})
+  // This is the default behavior
+  if ( options.coerceData ) {
+    // coerces the minimum value to zero because the mimimum option is only used for range validation, 
+    // not display https://github.com/sindresorhus/sparkly/blob/9e33eaff891c41e8fb8c8883f62e9821729a9882/index.js#L15
+    // sparkly(open,{minimum:27,maximum:50})
+    data = data.map( x=> x- minValue)
+  }
+
 
-  // TODO add option to not display labels issue #148
-  return `${label} [${minValue},${maxValue}] ${sparkly(data.map( x=> x- minValue))} ${lastValue}`
+  let sparkline
+  if (label) {
+    sparkline = `${label} [${minValue},${maxValue}] ${sparkly(data)} ${lastValue}`
+  } else {
+    sparkline = sparkly(data)
+  }
+  return sparkline
 }
 
 /**

package/src/helpers.test.js

@@ -8,14 +8,27 @@ describe('helpers',()=> {
         expect(helper.toTitleCase(lowerString)).toBe(titleString);
     })
 
-    it('should return the correctly sparkline',()=>{
+    it('should return the correctly formatted sparkline',()=>{
         const expectedOutput = 'last 30 days [1,5] ▁▂▄▆█ 5'
         const input = [1,2,3,4,5]
         const label = 'last 30 days'
         expect(helper.sparkline(input,label)).toBe(expectedOutput)
+    })
 
+    it('should return a sparkline with no additional labeling',()=>{
+        const expectedOutput = '▁▂▄▆█'
+        const input = [1,2,3,4,5]
+        const label = ''
+        expect(helper.sparkline(input,label)).toBe(expectedOutput)
     })
 
+    it('should return a sparkline with no range coercion',()=>{
+        const expectedOutput = '▂▄▅▇█'
+        const input = [1,2,3,4,5]
+        const label = ''
+        const options = { coerceData: false }
+        expect(helper.sparkline(input,label, options)).toBe(expectedOutput)
+    })
 
 })