edfcore 0.4.246 → 0.4.247

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

package/docs/CHANGELOG.md

@@ -6,6 +6,18 @@ 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.247
+
+- **Added** documentation for the three envelope result types, taking the recorded undocumented
+  list from eight to five. `readEnvelope` resolves to `EdfEnvelopeChunk[]` and every page showed
+  `chunk.signals[0].min` without naming what `chunk` is, so anyone writing a plotting function
+  that takes one had to read the `.d.ts`. `api-helpers.md` now gives `EdfEnvelopeChunk` and
+  `EdfEnvelopeSignal` field tables, and says the thing that is easy to get wrong: `bucketCount` is
+  buckets in the grid whether filled or not, `readEnvelope` clamps it to the densest signal's
+  sample count and `readEnvelopeAtResolution` deliberately does not, and `counts` — not `min` and
+  `max` — is what answers whether a bucket holds anything. `EdfPhysicalEnvelope` is named under
+  physical units, with why it is a type of its own.
+
 ## 0.4.246
 
 - **Changed** a release to be one commit instead of two. `scripts/release.mjs` refused a dirty

package/package.json

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