edfcore 0.4.335 → 0.4.337

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.335";
112
+ export declare const VERSION = "0.4.337";
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.335';
82
+ export const VERSION = '0.4.337';
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.337
10
+
11
+ - **Added** an execution of the annotation listing on `quick-start.md`. The page's own format
12
+ string is transcribed and applied to what `readAnnotations` returns, and it has to reproduce all
13
+ three printed lines exactly — which catches a `durationSeconds` arriving as `0` instead of
14
+ `undefined`, since that would print `(+0 s)` on an event with no duration, a different claim
15
+ about the recording.
16
+ - The docblock states what the check does NOT claim. The fixture is built from the page's own
17
+ lines, so the onset values vouch for themselves and a page edit changes both sides. Two things
18
+ are independent of that and are checked as such: the formatting between the numbers, and that
19
+ every decimal onset survives the round trip as a whole number of ticks, whatever the decimal is.
20
+ - Also pinned: the record range `readAnnotations` requires, which the page says has no default
21
+ because scanning a whole file for annotations is expensive.
22
+
23
+ ## 0.4.336
24
+
25
+ - **Fixed** wrong advice on `quick-start.md`. It said an annotation carries its onset "three ways"
26
+ and then named `onsetSecondsFromFirstRecord`, `onsetSecondsFromHeaderStart` and `onsetTicks` —
27
+ one float from each axis and a bigint from only one of them — closing with "Print the seconds;
28
+ compare the ticks." Followed literally on a file that declares a sub-second start offset, that
29
+ prints the rebased seconds and compares the header-axis ticks: on a 0.5 s offset, an event shown
30
+ at 1.25 s and tested at 1.75 s, silently.
31
+ - There are four fields, two per axis, and `annotations.md` has had them right in a table all
32
+ along. The quick start now names both members of both pairs, keeps the "print the seconds,
33
+ compare the ticks" advice with "from the same axis" attached, and says what the two axes differ
34
+ by. Checked on a file with an offset and again on one without, where the two collapse — which is
35
+ why this was easy to miss.
36
+ - This is the same shape as the defect the rename in 0.3.0 exists to prevent: two quantities that
37
+ agree on an ordinary file and part company on the one that matters.
38
+
9
39
  ## 0.4.335
10
40
 
11
41
  - **Added** a check over the console output `quick-start.md` prints. Between two `text` blocks the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.4.335",
3
+ "version": "0.4.337",
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.335';
96
+ export const VERSION = '0.4.337';