@thi.ng/dsp 4.7.20 → 4.7.21

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-09T13:46:38Z
+- **Last updated**: 2024-03-13T14:04:31Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/addg.d.ts

@@ -9,10 +9,12 @@ import type { IGen } from "./api.js";
  * gen.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/addg.ts
  * import { addG, constant } from "@thi.ng/dsp";
  *
- * addG(constant(1), 10).take(5)
+ * console.log(
+ *   addG(constant(1), 10).take(5)
+ * );
  * // [ 10, 11, 12, 13, 14 ]
  * ```
  *

package/convert.d.ts

@@ -33,11 +33,13 @@ export declare const radFreq: FnN2;
  * rate.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/ms-frames.ts
  * import { msFrames } from "@thi.ng/dsp";
  *
  * // samples per 20 ms @ 44.1kHz
- * msFrames(20, 44100)
+ * console.log(
+ *   msFrames(20, 44100)
+ * );
  * // 882
  * ```
  *

package/curve.d.ts

@@ -16,10 +16,12 @@ import { MAdd } from "./madd.js";
  * Also see {@link madd}.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/curve.ts
  * import { curve } from "@thi.ng/dsp";
  *
- * curve(-1, 1, 5, 0.1).take(7)
+ * console.log(
+ *   curve(-1, 1, 5, 0.1).take(7)
+ * );
  * // [
  * //   -1,
  * //   -0.04228753006664476,

package/fft.d.ts

@@ -28,28 +28,36 @@ export declare const copyComplex: (complex: ComplexArray) => ComplexArray;
  * reverse order.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/conjugate1.ts
  * import { conjugate } from "@thi.ng/dsp";
  *
- * conjugate([0, 3, 2, 1], true)
+ * console.log(
+ *   conjugate([0, 3, 2, 1], true)
+ * );
  * // Float64Array [ 0, 3, 2, 1, 0, -1, -2, -3 ]
  *
- * conjugate([0, 3, 2, 1], false)
+ * console.log(
+ *   conjugate([0, 3, 2, 1], false)
+ * );
  * // Float64Array [ 0, 3, 2, 1, 0, 1, 2, 3 ]
  *
- * conjugate([[0, 1, 0, 1], [0, -0.5, 0, -0.25]])
- * [
- *   Float64Array [ 0, 1, 0, 1, 0, 1, 0, 1 ],
- *   Float64Array [ 0, -0.5, 0, -0.25, 0, 0.25, 0, 0.5 ]
- * ]
+ * console.log(
+ *   conjugate([[0, 1, 0, 1], [0, -0.5, 0, -0.25]])
+ * );
+ * // [
+ * //   Float64Array [ 0, 1, 0, 1, 0, 1, 0, 1 ],
+ * //   Float64Array [ 0, -0.5, 0, -0.25, 0, 0.25, 0, 0.5 ]
+ * // ]
  * ```
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/conjugate2.ts
  * import { conjugate, ifft } from "@thi.ng/dsp";
  *
  * // generate single-period sine (window size = 16)
- * ifft(conjugate([0, -8, 0, 0, 0, 0, 0, 0]))[0]
+ * console.log(
+ *   ifft(conjugate([0, -8, 0, 0, 0, 0, 0, 0]))[0]
+ * );
  * // [
  * //   0, 0.383, 0.707, 0.924,
  * //   1, 0.924, 0.707, 0.383,

package/line.d.ts

@@ -10,10 +10,12 @@ import { Add } from "./add.js";
  * if more than `n + 1` values are requested from the generator.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/line.ts
  * import { line } from "@thi.ng/dsp";
  *
- * line(0, 1, 5).take(7)
+ * console.log(
+ *   line(0, 1, 5).take(7)
+ * );
  * // [ 0, 0.2, 0.4, 0.6, 0.8, 1, 1.2 ]
  * ```
  *

package/osc.d.ts

@@ -33,7 +33,7 @@ export declare const osc: (osc: StatelessOscillator, freq: IGen<number> | number
  * range, added to the main oscillator `freq`.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/mod-osc.ts
  * import { modOsc, osc, saw, sin, rect } from "@thi.ng/dsp";
  *
  * // FM sin osc using rect osc as frequency modulator
@@ -44,7 +44,6 @@ export declare const osc: (osc: StatelessOscillator, freq: IGen<number> | number
  *
  * // FM & AM sin osc using rect osc as fmod and saw as amod
  * modOsc(sin, 0.01, osc(rect, 0.1, 0.2), osc(saw, 0.05))
- *
  * ```
  *
  * @param osc - stateless main osc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dsp",
-  "version": "4.7.20",
+  "version": "4.7.21",
   "description": "Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils",
   "type": "module",
   "module": "./index.js",
@@ -37,19 +37,19 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.29",
-    "@thi.ng/checks": "^3.5.2",
-    "@thi.ng/errors": "^2.4.20",
-    "@thi.ng/math": "^5.10.6",
-    "@thi.ng/random": "^3.6.36",
-    "@thi.ng/transducers": "^8.9.11"
+    "@thi.ng/api": "^8.9.30",
+    "@thi.ng/checks": "^3.5.3",
+    "@thi.ng/errors": "^2.5.0",
+    "@thi.ng/math": "^5.10.7",
+    "@thi.ng/random": "^3.6.37",
+    "@thi.ng/transducers": "^8.9.12"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.40.1",
-    "esbuild": "^0.20.0",
+    "@microsoft/api-extractor": "^7.42.3",
+    "esbuild": "^0.20.1",
     "rimraf": "^5.0.5",
-    "typedoc": "^0.25.7",
-    "typescript": "^5.3.3"
+    "typedoc": "^0.25.12",
+    "typescript": "^5.4.2"
   },
   "keywords": [
     "allpass",
@@ -289,5 +289,5 @@
     ],
     "year": 2015
   },
-  "gitHead": "0d3bacf526db92363b43e81356e8cef18368272a\n"
+  "gitHead": "7f3fcbd6c0462b0ce45afa141fe163d1f297fd51\n"
 }

package/sweep.d.ts

@@ -5,18 +5,20 @@
  * clamped at the given `end` value.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/sweep.ts
  * import { adsr, osc, sin, sweep } from "@thi.ng/dsp";
  *
+ * // sample rate
+ * const FS = 44100
+ *
  * // render 2 sec osc sweep from 100 - 10000Hz
- * // FS = 44100
  * osc(
  *   sin,
  *   // freq & phase gen
  *   sweep(100 / FS, 10000 / FS, 2 * FS, 0.1),
  *   // amplitude gen / envelope
- *   adsr(0.5 * FS, 1.5 * FS, 0)
- * ).take(2 * fs)
+ *   adsr({ a: 0.5 * FS, r: 1.5 * FS, slen: 0 })
+ * ).take(2 * FS)
  * // [...]
  * ```
  *