edfcore 0.4.517 → 0.4.519
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.
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/docs/CHANGELOG.md +38 -0
- package/package.json +1 -1
- package/src/constants.ts +1 -1
package/dist/constants.d.ts
CHANGED
|
@@ -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.
|
|
112
|
+
export declare const VERSION = "0.4.519";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/docs/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,44 @@ 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.519
|
|
10
|
+
|
|
11
|
+
- **Added** an offline check of the claim `api-helpers.md` makes for `streamRecords`: "a streamed
|
|
12
|
+
chunk and a read chunk are the same object in every respect, diagnostics included". It is what
|
|
13
|
+
lets a caller develop against `readWindow` and switch to streaming for the twenty-two-hour file
|
|
14
|
+
without touching their own downstream code.
|
|
15
|
+
- It was checked in exactly one place, `tests/corpus/large-file.test.ts`, which skips without
|
|
16
|
+
`npm run corpus:fetch` — so on a fresh clone nothing compared the two at all. And that comparison
|
|
17
|
+
is of samples, which is the half that survives a chunk losing its diagnostics, its
|
|
18
|
+
`precededByGap` or its byte accounting.
|
|
19
|
+
- "Every respect" is now taken literally: each streamed chunk is compared field for field with the
|
|
20
|
+
chunk `readRecords` returns for the same records, at four chunk sizes. The fixture makes the
|
|
21
|
+
usually-empty fields non-empty — a gap in the middle so one chunk carries a `precededByGap`, a
|
|
22
|
+
malformed TAL onset so one carries a diagnostic — because a chunk whose optional fields are all
|
|
23
|
+
absent compares equal to a chunk that dropped them, and the run asserts both were populated.
|
|
24
|
+
- The two claims in the same sentence are checked beside it: the chunks arrive in time order, and
|
|
25
|
+
none spans a gap at any chunk size. The second is what makes `durationTicks` mean what a reader
|
|
26
|
+
thinks — `readRecords` will hand back a chunk straddling a discontinuity, because you named the
|
|
27
|
+
records, and a streamed chunk must never be one.
|
|
28
|
+
|
|
29
|
+
## 0.4.518
|
|
30
|
+
|
|
31
|
+
- **Added** the other convention `api-types.md` states in bold: "Anything checkable against the
|
|
32
|
+
file is exposed twice", as the parsed value and as the raw bytes it came from, padding intact.
|
|
33
|
+
It is a convention rather than a nicety because of the sentence after it — a header field that
|
|
34
|
+
disagrees with what edfcore made of it is what you need when a file misbehaves — so the raw side
|
|
35
|
+
is the evidence a bug report is written from, and evidence that is not the file's own bytes is
|
|
36
|
+
worse than none.
|
|
37
|
+
- `type-tables.test.ts` checks the raw interfaces list every field, and individual tests quote a
|
|
38
|
+
raw value here and there. Nothing checked the convention: that each of the ten fixed fields and
|
|
39
|
+
the ten per-signal fields, on every signal, is exactly the bytes the layout puts at that offset,
|
|
40
|
+
decoded the way the header is decoded and not trimmed on the way out.
|
|
41
|
+
- The per-signal half is where a mistake would be invisible. The block is field-major, so one
|
|
42
|
+
signal's ten fields are ten different places in the header, each `256 + ns * before + i * width`,
|
|
43
|
+
and reading one from a neighbour's slot yields a plausible string rather than an error. The
|
|
44
|
+
fixture gives all three signals different values for every field and leaves padding in each, so a
|
|
45
|
+
shifted index and a trimming reader both fail — both were tried, and both do.
|
|
46
|
+
|
|
9
47
|
## 0.4.517
|
|
10
48
|
|
|
11
49
|
- **Added** the convention `api-types.md` states in bold above every table on the page: "A field
|
package/package.json
CHANGED
package/src/constants.ts
CHANGED