edfcore 0.4.352 → 0.4.354

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.352";
112
+ export declare const VERSION = "0.4.354";
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.352';
82
+ export const VERSION = '0.4.354';
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.354
10
+
11
+ - **Added** a compile check over every signature the reference pages print. Four pages open each
12
+ function with a `ts` fence holding its declaration and nothing else — thirty-odd across
13
+ `api-primitives`, `api-reading`, `api-sources` and `api-validate` — and every one is hand-typed.
14
+ They are the first thing a reader sees for a function and what they write their call against.
15
+ - `doc-snippets-compile.test.ts` compiles the fences that are complete programs and skips these: a
16
+ bare declaration imports nothing, so it never matched the filter that finds runnable examples.
17
+ The most load-bearing line on each reference page was the one nothing compiled.
18
+ - Assignability is checked in BOTH directions, which is the difference between "the documented
19
+ shape is usable" and "the documented shape is the real one" — one direction alone accepts a page
20
+ that widens a parameter or narrows a return, and a widened parameter describes a function that
21
+ does not exist. Signatures are extracted per fence rather than by scanning the page, because a
22
+ lazy match for the parameter list's closing paren runs past it into the prose: `Promise<{ … }>`
23
+ has no `):` to stop at and the next parenthetical sentence does.
24
+ - The types a declaration mentions are resolved through `barrel-types.ts` rather than a hard-coded
25
+ list. The first version used a list and missed four, which is the failure that helper was
26
+ extracted to stop repeating.
27
+
28
+ ## 0.4.353
29
+
30
+ - **Added** a cross-check between the two places `openEdf`'s cost is published. `large-files.md`
31
+ states it as a four-row table and `api-reading.md` states it as a sentence, and both are read by
32
+ someone deciding whether opening a file is cheap enough to do on a click.
33
+ - The table was already checked against the library in 0.4.340. This checks the prose against the
34
+ table, so all three agree rather than two agreeing while a third drifts — the shape this
35
+ repository keeps finding wrong, in the section list, the diagnostic tables and the `ByteSource`
36
+ interface before it. It is also the cheaper direction to automate: the prose spells its counts as
37
+ words, and nobody diffs a word against a digit by eye.
38
+
9
39
  ## 0.4.352
10
40
 
11
41
  - **Added** `tests/property/window-cost.test.ts`, which states in general what four checks in this
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.4.352",
3
+ "version": "0.4.354",
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.352';
96
+ export const VERSION = '0.4.354';