edfcore 0.6.113 → 0.6.114

package/dist/constants.d.ts

@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
     readonly reserved: 224;
 };
 /** Published package version. Kept in sync with package.json by a test. */
-export declare const VERSION = "0.6.113";
+export declare const VERSION = "0.6.114";
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -79,5 +79,5 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
     reserved: 224,
 };
 /** Published package version. Kept in sync with package.json by a test. */
-export const VERSION = '0.6.113';
+export const VERSION = '0.6.114';
 //# sourceMappingURL=constants.js.map

package/dist/options.d.ts

@@ -1,7 +1,8 @@
 /**
  * Numeric options, refused rather than silently coerced.
  *
- * Layer 1. Imports one constant and nothing else, so every layer can reach it — which is the
+ * Layer 1. Imports one constant and one Layer 1 helper that imports nothing, so every layer can
+ * reach it — which is the
  * point: `maxMaterializeBytes` is resolved in six modules spread across the stack — `io/read.ts`,
  * `decode/digital.ts`, `decode/physical.ts`, `record-index.ts`, `envelope.ts` and `validate.ts` —
  * and read raw and handed on in two more, `io/cached.ts` and `biosemi.ts`. A guard that only one

package/dist/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,GACf,MAAM,CAQR;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAUjF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAQ1E"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAKH;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,GACf,MAAM,CAqBR;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAUjF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAQ1E"}

package/dist/options.js

@@ -1,7 +1,8 @@
 /**
  * Numeric options, refused rather than silently coerced.
  *
- * Layer 1. Imports one constant and nothing else, so every layer can reach it — which is the
+ * Layer 1. Imports one constant and one Layer 1 helper that imports nothing, so every layer can
+ * reach it — which is the
  * point: `maxMaterializeBytes` is resolved in six modules spread across the stack — `io/read.ts`,
  * `decode/digital.ts`, `decode/physical.ts`, `record-index.ts`, `envelope.ts` and `validate.ts` —
  * and read raw and handed on in two more, `io/cached.ts` and `biosemi.ts`. A guard that only one
@@ -17,6 +18,7 @@
  * with the file, which is the same split `isEdfError` documents.
  */
 import { DEFAULT_MAX_MATERIALIZE_BYTES } from './constants.js';
+import { describeValue } from './text/describe.js';
 /**
  * `undefined` takes the default; anything non-finite throws. The two are kept apart deliberately:
  * an omitted option means "use the default", while a `NaN` means a caller computed something and
@@ -27,7 +29,20 @@ export function requireFiniteOption(value, name, fallback) {
         return fallback;
     if (Number.isFinite(value))
         return value;
-    throw new RangeError(`options.${name} must be a finite number, but was ${String(value)}. Next: check the ` +
+    /*
+     * `describeValue`, not `String(value)`. The module note above is about a `number` that admits
+     * `NaN` and `Infinity`, and both read correctly when printed bare. A string does not:
+     * `Number.isFinite('1e9')` is false, so `maxMaterializeBytes: '1e9'` was refused — correctly —
+     * and then reported as "must be a finite number, but was 1e9", which is a finite number. That is
+     * the shape 0.6.92, 0.6.94 and 0.6.99 were spent on, in the one module whose whole subject is
+     * options "refused rather than silently coerced"; its own sweep reached six guards and not this
+     * one, which sits under eight (fixed in 0.6.114).
+     *
+     * A string is also the value this guard most often meets. Every source the note names —
+     * `process.env`, `searchParams.get`, a JSON config — hands over a string, and the note's own
+     * example wraps it in `Number()` precisely because the raw value is one.
+     */
+    throw new RangeError(`options.${name} must be a finite number, but was ${describeValue(value)}. Next: check the ` +
         'expression that produced it — Number() on an absent environment variable, query ' +
         'parameter or config key yields NaN.');
 }

package/dist/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAyB,EACzB,IAAY,EACZ,QAAgB;IAEhB,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACzC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,MAAM,IAAI,UAAU,CAClB,WAAW,IAAI,qCAAqC,MAAM,CAAC,KAAK,CAAC,oBAAoB;QACnF,kFAAkF;QAClF,qCAAqC,CACxC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAyB,EAAE,KAAa;IACvE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,UAAU,CAClB,2FAA2F;YACzF,wFAAwF;YACxF,gCAAgC,CACnC,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAyB;IAChE,MAAM,MAAM,GAAG,mBAAmB,CAAC,KAAK,EAAE,qBAAqB,EAAE,6BAA6B,CAAC,CAAC;IAChG,IAAI,MAAM,IAAI,CAAC;QAAE,OAAO,MAAM,CAAC;IAC/B,MAAM,IAAI,UAAU,CAClB,6DAA6D,MAAM,0BAA0B;QAC3F,0DAA0D;QAC1D,GAAG,6BAA6B,gBAAgB,CACnD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAyB,EACzB,IAAY,EACZ,QAAgB;IAEhB,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACzC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC;;;;;;;;;;;;OAYG;IACH,MAAM,IAAI,UAAU,CAClB,WAAW,IAAI,qCAAqC,aAAa,CAAC,KAAK,CAAC,oBAAoB;QAC1F,kFAAkF;QAClF,qCAAqC,CACxC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAyB,EAAE,KAAa;IACvE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,UAAU,CAClB,2FAA2F;YACzF,wFAAwF;YACxF,gCAAgC,CACnC,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAyB;IAChE,MAAM,MAAM,GAAG,mBAAmB,CAAC,KAAK,EAAE,qBAAqB,EAAE,6BAA6B,CAAC,CAAC;IAChG,IAAI,MAAM,IAAI,CAAC;QAAE,OAAO,MAAM,CAAC;IAC/B,MAAM,IAAI,UAAU,CAClB,6DAA6D,MAAM,0BAA0B;QAC3F,0DAA0D;QAC1D,GAAG,6BAA6B,gBAAgB,CACnD,CAAC;AACJ,CAAC"}

package/docs/CHANGELOG.md

@@ -6,6 +6,20 @@ alone does not tell you whether you were affected.
 edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
 defect; those are called out below.
 
+## 0.6.114
+
+- **Changed** how `options.ts` describes a rejected option value. It printed with `String(value)`, so
+  `maxMaterializeBytes: '1e9'` was refused — correctly, `Number.isFinite('1e9')` is false — and then
+  reported as "must be a finite number, but was 1e9", which is a finite number.
+- This is the module under eight of the guards 0.6.99 swept and it was not one of them.
+  `maxMaterializeBytes` is resolved in six modules; `blockBytes`, `maxBytes` and `maxConcurrency` in
+  two more.
+- A string is the value this guard most often meets. Every source its own module note names —
+  `process.env`, `searchParams.get`, a JSON config — hands over a string, and the note's example
+  wraps it in `Number()` precisely because the raw value is one.
+- The sweep now reaches an options path, so the guard under the guards is covered by the check that
+  found the rest.
+
 ## 0.6.113
 
 - **Fixed** `edfcore/validate`, the third entry point, which had no argument checks at all.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edfcore",
-  "version": "0.6.113",
+  "version": "0.6.114",
   "description": "Modern, typed, zero-dependency reader for EDF, EDF+, BDF and BDF+ biosignal files. Works in browsers and Node with true random access.",
   "keywords": [
     "edf",

package/src/constants.ts

@@ -93,4 +93,4 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
 } as const;
 
 /** Published package version. Kept in sync with package.json by a test. */
-export const VERSION = '0.6.113';
+export const VERSION = '0.6.114';

package/src/options.ts

@@ -1,7 +1,8 @@
 /**
  * Numeric options, refused rather than silently coerced.
  *
- * Layer 1. Imports one constant and nothing else, so every layer can reach it — which is the
+ * Layer 1. Imports one constant and one Layer 1 helper that imports nothing, so every layer can
+ * reach it — which is the
  * point: `maxMaterializeBytes` is resolved in six modules spread across the stack — `io/read.ts`,
  * `decode/digital.ts`, `decode/physical.ts`, `record-index.ts`, `envelope.ts` and `validate.ts` —
  * and read raw and handed on in two more, `io/cached.ts` and `biosemi.ts`. A guard that only one
@@ -18,6 +19,7 @@
  */
 
 import { DEFAULT_MAX_MATERIALIZE_BYTES } from './constants.js';
+import { describeValue } from './text/describe.js';
 
 /**
  * `undefined` takes the default; anything non-finite throws. The two are kept apart deliberately:
@@ -31,8 +33,21 @@ export function requireFiniteOption(
 ): number {
   if (value === undefined) return fallback;
   if (Number.isFinite(value)) return value;
+  /*
+   * `describeValue`, not `String(value)`. The module note above is about a `number` that admits
+   * `NaN` and `Infinity`, and both read correctly when printed bare. A string does not:
+   * `Number.isFinite('1e9')` is false, so `maxMaterializeBytes: '1e9'` was refused — correctly —
+   * and then reported as "must be a finite number, but was 1e9", which is a finite number. That is
+   * the shape 0.6.92, 0.6.94 and 0.6.99 were spent on, in the one module whose whole subject is
+   * options "refused rather than silently coerced"; its own sweep reached six guards and not this
+   * one, which sits under eight (fixed in 0.6.114).
+   *
+   * A string is also the value this guard most often meets. Every source the note names —
+   * `process.env`, `searchParams.get`, a JSON config — hands over a string, and the note's own
+   * example wraps it in `Number()` precisely because the raw value is one.
+   */
   throw new RangeError(
-    `options.${name} must be a finite number, but was ${String(value)}. Next: check the ` +
+    `options.${name} must be a finite number, but was ${describeValue(value)}. Next: check the ` +
       'expression that produced it — Number() on an absent environment variable, query ' +
       'parameter or config key yields NaN.',
   );