edfcore 0.4.501 → 0.4.503

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
109
109
  readonly reserved: 224;
110
110
  };
111
111
  /** Published package version. Kept in sync with package.json by a test. */
112
- export declare const VERSION = "0.4.501";
112
+ export declare const VERSION = "0.4.503";
113
113
  //# sourceMappingURL=constants.d.ts.map
package/dist/constants.js CHANGED
@@ -79,5 +79,5 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
79
79
  reserved: 224,
80
80
  };
81
81
  /** Published package version. Kept in sync with package.json by a test. */
82
- export const VERSION = '0.4.501';
82
+ export const VERSION = '0.4.503';
83
83
  //# sourceMappingURL=constants.js.map
package/docs/CHANGELOG.md CHANGED
@@ -6,6 +6,36 @@ alone does not tell you whether you were affected.
6
6
  edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
7
7
  defect; those are called out below.
8
8
 
9
+ ## 0.4.503
10
+
11
+ - **Added** the two snippets on `api-reading.md` that print values — what `openEdf` reports for an
12
+ eight-hour EDF+C, and what `buildRecordIndex` reports for a file with a one-minute hole — plus
13
+ the progress contract stated beside them.
14
+ - `documented-read-counts.test.ts` covers that page's read counts. These are the blocks where it
15
+ prints fields, and they had nothing behind them.
16
+ - The `onProgress` sentences are the part worth pinning, because a caller writes code against them
17
+ and cannot test them cheaply: "fires once per chunk", and "a file with no annotations signal is
18
+ not scanned at all … `onProgress` still fires once with the traversal complete, so a progress bar
19
+ finishes". A bar that stops short is the kind of defect that ships — it looks like slowness, the
20
+ file is fine, and nothing throws.
21
+ - Dropping either call site now fails a test. Neither did before.
22
+
23
+ ## 0.4.502
24
+
25
+ - **Added** a property test for the round trip between `sampleStartTicksOf` and `sampleAt` — the
26
+ pair a viewer uses, a cursor position in and a sample index out.
27
+ - `api-helpers.md` states the rule as a four-way agreement: "`sampleAt`, `sampleStartTicksOf`, a
28
+ window bound and `readTriggers` all name the same sample." 0.3.32 settled it after `readTriggers`
29
+ disagreed with the other three, and 0.3.56 moved a window bound onto it after the same mismatch
30
+ turned up there. Both fixes were made against examples.
31
+ - `sample-grid-roundtrip.test.ts` covers the pure pair, which takes a SIGNAL and knows nothing
32
+ about gaps. These take the RECORDING, and that is the difference: after a hole a sample's instant
33
+ is not its index times the interval, so inverting it means finding the segment first. That half
34
+ was only ever checked at chosen points.
35
+ - Four geometries, two of them with a sample interval that is not a whole number of ticks, each run
36
+ contiguous and again across a ten-second hole — and once more in ticks rather than seconds, since
37
+ a trip through seconds can close on rounding luck.
38
+
9
39
  ## 0.4.501
10
40
 
11
41
  - **Added** the four normalisations `api-sources.md` states for `cachedSource`'s two options:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.4.501",
3
+ "version": "0.4.503",
4
4
  "description": "Modern, typed, zero-dependency reader for EDF, EDF+, BDF and BDF+ biosignal files. Works in browsers and Node with true random access.",
5
5
  "keywords": [
6
6
  "edf",
package/src/constants.ts CHANGED
@@ -93,4 +93,4 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
93
93
  } as const;
94
94
 
95
95
  /** Published package version. Kept in sync with package.json by a test. */
96
- export const VERSION = '0.4.501';
96
+ export const VERSION = '0.4.503';