edfcore 0.5.63 → 0.5.64

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.5.63";
112
+ export declare const VERSION = "0.5.64";
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.5.63';
82
+ export const VERSION = '0.5.64';
83
83
  //# sourceMappingURL=constants.js.map
package/docs/CHANGELOG.md CHANGED
@@ -6,6 +6,31 @@ 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.5.64
10
+
11
+ - **Added** the reading half of "edfcore reads, it does not write". `reads-not-writes.test.ts`
12
+ checks the five places the package SAYS so — the README, AGENTS.md, `comparison.md`,
13
+ `design-decisions.md` and the npm keywords — and all five are about the missing feature: edfcore
14
+ produces no EDF files. None of them is about the bytes you already have, which is the exposure a
15
+ caller has without reading a page.
16
+ - It is structural rather than hypothetical. `byteSource` is zero-copy, so `readRecordBytes` hands
17
+ `decodeInt16` a `subarray` of the caller's own array, and a decode loop that wrote where it meant
18
+ to read would corrupt the caller's copy of their recording in place — with nothing downstream
19
+ looking wrong, because the samples returned would still be the samples that were there.
20
+ - `we-never-write-your-bytes.test.ts` captures the buffer, runs open, index, a full validation
21
+ sweep, inspect, annotations, records, windows, envelopes, a stream and scaling over it, and
22
+ requires it byte for byte afterwards — over all ten `AWKWARD` shapes and a gapped file, in two
23
+ wirings.
24
+ - The two wirings are the point. Behind `cachedSource` every decode runs over the cache's own copy,
25
+ so a write in the decoder can never reach the caller and that half of the sweep would pass
26
+ regardless. Unwrapped is the case that carries the property. Putting an in-place write in
27
+ `decodeInt16` fails the unwrapped half on eight files and leaves the cached half green, which is
28
+ what makes the distinction worth spelling out rather than wiring one and moving on.
29
+ - `fileSource` is asked the same thing of the filesystem, where a write would be worse: the bytes
30
+ on disk and the file's modification time both survive a full read. And the one buffer edfcore
31
+ does write into is asserted to BE written — `out` on `toPhysical` — so the rule reads as a rule
32
+ and not as a tautology.
33
+
9
34
  ## 0.5.63
10
35
 
11
36
  - **Added** the other half of the zero-copy bargain. `byteSource` is documented as handing out
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.5.63",
3
+ "version": "0.5.64",
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.5.63';
96
+ export const VERSION = '0.5.64';