edfcore 0.4.496 → 0.4.498

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.496";
112
+ export declare const VERSION = "0.4.498";
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.496';
82
+ export const VERSION = '0.4.498';
83
83
  //# sourceMappingURL=constants.js.map
package/docs/CHANGELOG.md CHANGED
@@ -6,6 +6,41 @@ 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.498
10
+
11
+ - **Fixed** an error message quoted on two documentation pages that no version of edfcore has been
12
+ producing. `concepts.md` and `discontinuous.md` both print the `RangeError` you get for asking a
13
+ time question of a probed index, and both quoted it as "a probed index knows where neither the
14
+ gap nor the records after it start" — the library says "the discontinuity", and has since the
15
+ wording was narrowed.
16
+ - Both were also missing a whole clause. The real message ends "Exactly: 160000000 against
17
+ 60000000 ticks of 100 ns" before its `Next:`, and that sentence exists because the two second
18
+ counts in the clause above it can PRINT the same on a long recording. The pages had dropped the
19
+ one clause that makes the message actionable in the case it was written for.
20
+ - Rewording an error is a small edit in a different file, which is why a quotation of one rots.
21
+ Found by running the walk-through rather than by reading it.
22
+ - **Added** the rest of that walk-through as a test: the probed index admitting what it has not
23
+ seen, the span and coverage that differ, the two segments and one gap a scan finds, and the two
24
+ chunks the same `readWindow` call becomes once it has an index — with `precededByGap` on the
25
+ second and not the first.
26
+
27
+ ## 0.4.497
28
+
29
+ - **Added** a test that runs the example on `annotations.md` — the page a reader lands on from a
30
+ search for how to read EDF+ events. The region's own header fields, the four events a full-file
31
+ read returns, and what a scan of a 200-record file costs were all prose.
32
+ - The transcript is the part worth having under test. `-0.75 undefined pre-stimulus baseline` says
33
+ four things at once: onsets are relative to record 0, a negative onset is legal and kept, an
34
+ absent duration is `undefined` rather than `0`, and the list is sorted by time across record
35
+ boundaries. Any one of those changing leaves the page describing a library that no longer behaves
36
+ that way, and none of them is something a reader would think to doubt.
37
+ - The read-cost block goes with it, because it is what the page uses to argue for spelling the
38
+ record range out at the call site: a full scan of a twelve-hour study is a full download of it.
39
+ Both rows are checked as one read of the size printed, and against the arithmetic — count records
40
+ at the record size.
41
+ - Also pinned: a file with no annotations channel returns an empty list with no diagnostics, and
42
+ still returns the onset grid. That is a whole paragraph of the page and one line of assertions.
43
+
9
44
  ## 0.4.496
10
45
 
11
46
  - **Added** a test that builds and runs the file `api-types.md` documents itself with. That page
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.4.496",
3
+ "version": "0.4.498",
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.496';
96
+ export const VERSION = '0.4.498';