From 85e86c4d4bed4708745200165d83bf6b4c001834 Mon Sep 17 00:00:00 2001 From: jobo322 Date: Fri, 23 Aug 2024 09:49:52 -0500 Subject: [PATCH] fix: add types file --- ml-matrix-peaks-finder.d.ts | 25 +++++++++++++++++++++++++ package.json | 1 + 2 files changed, 26 insertions(+) create mode 100644 ml-matrix-peaks-finder.d.ts diff --git a/ml-matrix-peaks-finder.d.ts b/ml-matrix-peaks-finder.d.ts new file mode 100644 index 0000000..f28c9b8 --- /dev/null +++ b/ml-matrix-peaks-finder.d.ts @@ -0,0 +1,25 @@ +declare module 'ml-matrix-peaks-finder' { + interface FindPeaks2DRegionOptions { + nStdDev: number; + kernel?: number[][] | Float64Array[]; + originalData: number[] | Float64Array; + filteredData: number[] | Float64Array; + rows: number; + cols: number; + labelling?: 'drain' | 'floodfill'; + } + interface Peak2D { + id?: string; + x: number; + y: number; + z: number; + maxX: number; + minX: number; + maxY: number; + minY: number; + } + function findPeaks2DRegion( + absoluteData: number[] | Float64Array, + options?: FindPeaks2DRegionOptions, + ): Peak2D[]; +} diff --git a/package.json b/package.json index 0f86e88..4cc1e53 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "description": "The peak picking routines for 2D arrays. This library looks for the local maxima of the given input matrix. The input matrix has to be specified as a single vector.", "main": "lib/index.js", "module": "src/index.js", + "types": "ml-matrix-peaks-finder.d.ts", "files": [ "lib", "src"