edfcore 0.4.499 → 0.4.501

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.499";
112
+ export declare const VERSION = "0.4.501";
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.499';
82
+ export const VERSION = '0.4.501';
83
83
  //# sourceMappingURL=constants.js.map
package/docs/CHANGELOG.md CHANGED
@@ -6,6 +6,37 @@ 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.501
10
+
11
+ - **Added** the four normalisations `api-sources.md` states for `cachedSource`'s two options:
12
+ `blockBytes` floored, never below 1, clamped down to `maxBytes`; `maxBytes` floored, never below
13
+ 0. None was checked.
14
+ - Each exists because a caller computes these numbers rather than typing them — a block size
15
+ derived from `header.recordByteLength`, a budget read from an environment variable, a fraction of
16
+ `navigator.deviceMemory`. `hardening.test.ts` covers the NaN refusals, which are a different rule
17
+ with an error attached, and `cache.test.ts` passes whole numbers throughout.
18
+ - What the flooring costs is not obvious from the table, which is why the table is worth executing.
19
+ Rounding up fetches more than the caller budgeted for on every miss; a `blockBytes` of 0 that was
20
+ not floored to 1 divides by zero working out which block an offset falls in.
21
+ - Each rule is checked through what the WRAPPED source is asked for, because that is the only place
22
+ the block size is observable — the cache has no accessor for it, deliberately.
23
+
24
+ ## 0.4.500
25
+
26
+ - **Added** the halves of `discontinuous.md` its existing test did not reach: what `openEdf` alone
27
+ reports, and what an overlap looks like.
28
+ - The overlap section is the one worth pinning. EDF+D never lets a record start before the previous
29
+ one ends; files do it anyway, and edfcore's answer is that there is no separate shape for it —
30
+ `EdfGap.durationSeconds` simply goes negative. The page demonstrates that with one line, `[-1, 1]`,
31
+ and a reader summing durations to get "time lost to gaps" needs it to be true.
32
+ - So the sum is asserted too: on that file it comes to zero seconds lost across a recording that
33
+ plainly has a hole in it, which is the warning the page prints under the example, made
34
+ executable.
35
+ - `gaps.length === segments.length - 1` is checked on the overlapping file specifically, since
36
+ that is the case where a reader would doubt a rule stated for "any file that has records".
37
+ - And the probed-index block, which is the page's other promise: nothing on the object `openEdf`
38
+ returns reads as "this recording is continuous" when nothing has looked.
39
+
9
40
  ## 0.4.499
10
41
 
11
42
  - **Added** the scaling contract as `concepts.md` states it: `signal.scale` is `undefined`,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.4.499",
3
+ "version": "0.4.501",
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.499';
96
+ export const VERSION = '0.4.501';