B10: document the interleaved layout of Node MACD/Bollinger batch

MacdNode.batch and BollingerNode.batch return flat interleaved arrays
(3*n and 4*n) but index.d.ts only said Array<number>. Adds /// doc
comments describing the layout; napi-rs now propagates them into the
generated index.d.ts as JSDoc.
This commit is contained in:
kingchenc
2026-05-22 04:15:31 +02:00
parent 59c435fbd5
commit 490ce28645
+6
View File
@@ -135,6 +135,9 @@ impl MacdNode {
histogram: o.histogram,
})
}
/// Batch over a price array. Returns a flat array of length `3 * n`,
/// interleaved per row as `[macd0, signal0, histogram0, macd1, ...]`.
/// Read column `j` of row `i` as `result[i * 3 + j]`. Warmup rows are `NaN`.
#[napi]
pub fn batch(&mut self, prices: Vec<f64>) -> Vec<f64> {
let mut out = vec![f64::NAN; prices.len() * 3];
@@ -193,6 +196,9 @@ impl BollingerNode {
stddev: o.stddev,
})
}
/// Batch over a price array. Returns a flat array of length `4 * n`,
/// interleaved per row as `[upper0, middle0, lower0, stddev0, upper1, ...]`.
/// Read column `j` of row `i` as `result[i * 4 + j]`. Warmup rows are `NaN`.
#[napi]
pub fn batch(&mut self, prices: Vec<f64>) -> Vec<f64> {
let mut out = vec![f64::NAN; prices.len() * 4];