feat: allow {x:[], y:[]} for peaks definition

src/__tests__/checkPeaks.test.js

@@ -0,0 +1,34 @@
+import { test, expect } from 'vitest';
+
+import { checkPeaks } from '../checkPeaks.js';
+
+test('object', () => {
+  const result = checkPeaks({ x: [1, 2, 3], y: [2, 3, 4] });
+  expect(result).toStrictEqual([
+    [1, 2, 3],
+    [2, 3, 4],
+  ]);
+});
+
+test('correct array', () => {
+  const result = checkPeaks([
+    [1, 2, 3],
+    [2, 3, 4],
+  ]);
+  expect(result).toStrictEqual([
+    [1, 2, 3],
+    [2, 3, 4],
+  ]);
+});
+
+test('array of [x,y]', () => {
+  const result = checkPeaks([
+    [1, 2],
+    [2, 3],
+    [3, 4],
+  ]);
+  expect(result).toStrictEqual([
+    [1, 2, 3],
+    [2, 3, 4],
+  ]);
+});

src/checkPeaks.js

@@ -10,6 +10,9 @@ export function checkPeaks(peaks) {
   if (Array.isArray(peaks) && Array.isArray(peaks[0]) && peaks.length === 2) {
     return peaks;
   }
+  if (Array.isArray(peaks.x) && Array.isArray(peaks.y)) {
+    return [peaks.x, peaks.y];
+  }
   const x = new Array(peaks.length);
   const y = new Array(peaks.length);
   for (let i = 0; i < peaks.length; i++) {

src/index.js

@@ -14,7 +14,7 @@ export const COMMON_BOTH = 3;
 
 /**
  * A number, or a string containing a number.
- * @typedef {([number[],number[]]|[number,number][])} Peaks
+ * @typedef {([number[],number[]]|[number,number][]|{x:number[],y:number[]})} Peaks
  */
 
 /**