edfcore 0.4.515 → 0.4.516

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.515";
112
+ export declare const VERSION = "0.4.516";
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.515';
82
+ export const VERSION = '0.4.516';
83
83
  //# sourceMappingURL=constants.js.map
package/docs/CHANGELOG.md CHANGED
@@ -6,6 +6,27 @@ 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.516
10
+
11
+ - **Added** the third column of the `EdfHeader` and `EdfSignal` tables on `api-types.md`, executed.
12
+ `type-tables.test.ts` already checks that both tables list every member of their interface in
13
+ declaration order, which settles the first column. The third is where the tables do their work:
14
+ most rows do not describe a field, they derive it — `dataByteLength` is
15
+ `recordCount * recordByteLength`, `sampleCount` is `samplesPerRecord * header.recordCount`,
16
+ `recordByteOffset` is an offset "within one data record" rather than within the file, and
17
+ `sampleRateHz` is `undefined` "exactly when that duration is `0`". None of it had been run.
18
+ - A wrong rule there is worse than a missing one, because these are the sentences a reader uses
19
+ instead of measuring. Someone who takes `recordByteOffset` for a file offset writes a seek that
20
+ lands in the header; someone who divides by `sampleRateHz` because the table did not warn them
21
+ gets `Infinity` on a legal annotations-only recording.
22
+ - Each rule is asserted twice: that the page still states it, quoting the row's own words, and that
23
+ the library obeys it. The quote is what makes the pair worth anything — a rule reworded on the
24
+ page fails here instead of drifting away from a test that only knew the behaviour.
25
+ - Reading the rows needs two things the obvious parser gets wrong. `recordByteLength` is a row in
26
+ BOTH tables and means different things in each, so a row is looked up under its `###` heading;
27
+ and a type cell writes a union as `number \| undefined`, so cells split on an unescaped pipe or
28
+ the rest of that row lands in the wrong column.
29
+
9
30
  ## 0.4.515
10
31
 
11
32
  - **Added** the thirteen pairs behind one sentence on `cli.md`: "Each is accepted and ignored by
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.4.515",
3
+ "version": "0.4.516",
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.515';
96
+ export const VERSION = '0.4.516';