edfcore 0.4.392 → 0.4.394

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.4.392";
+export declare const VERSION = "0.4.394";
 //# 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.4.392';
+export const VERSION = '0.4.394';
 //# sourceMappingURL=constants.js.map

package/docs/CHANGELOG.md

@@ -6,6 +6,41 @@ 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.4.394
+
+- **Added** a check that every field the error tables on `api-errors.md` document is on the error
+  you actually catch. Those tables are the point of the classes: a caller reads `matchingIndices`
+  to offer a choice of channel, `budgetBytes` to decide how much to ask for next time, `available`
+  to clamp a range, `receivedLength` to tell a short read from a truncated file.
+- `error-classes.test.ts` checks the class-to-`edfErrorKind` table above them, because that is what
+  a cross-realm `catch` switches on. The field tables underneath were never executed, and a renamed
+  field passes everything here: TypeScript is happy, because the rename is consistent inside the
+  package, the page still describes the old name, and the consumer reading it gets `undefined` —
+  which in a handler looks like "this error did not carry that detail" rather than a breaking
+  change.
+- So one error of each class is provoked by the condition its row describes, and every documented
+  field is looked for on the instance with the documented type. A field documented as `X |
+  undefined` may be absent, but the name still has to be one the class defines, which is what stops
+  a misspelt row from being unfalsifiable.
+
+## 0.4.393
+
+- **Added** a property test for the rule `design-decisions.md` states about out-of-range samples: a
+  sample outside the declared digital range comes back as it was stored, is counted for free during
+  decode, and converts on the affine map that produced the samples inside the range. Clamping
+  instead flat-tops real peaks and draws saturation the hardware did not produce, so `edfcore` ships
+  the clamp as a separate function you call on purpose — EDFlib clamps on read, and cross-validating
+  against it needs the same operation.
+- The unit tests check that with chosen values against chosen ranges. What examples cannot say is
+  that nothing clamps for some combination: a negative gain, a range that does not straddle zero, a
+  24-bit signal whose declared span is narrower than a 16-bit one's. Those are the shapes where a
+  stray `Math.min` looks correct in review.
+- Four properties over generated ranges, generated samples and both storage widths: the decoded
+  integers are the integers written, `outOfDigitalRangeCount` is what an independent pass finds,
+  the physical step per digital unit outside the range equals the step inside it — which is what
+  "extrapolates" means — and `clampToDigitalRange` moves exactly the samples outside the range and
+  nothing else.
+
 ## 0.4.392
 
 - **Added** a check that the docblocks reach the published types, which five other checks quietly

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edfcore",
-  "version": "0.4.392",
+  "version": "0.4.394",
   "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.4.392';
+export const VERSION = '0.4.394';