edfcore 0.4.361 → 0.4.363

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/README.md CHANGED
@@ -151,8 +151,12 @@ for (const d of recording.header.diagnostics) {
151
151
  }
152
152
  ```
153
153
 
154
- Every diagnostic carries the field, the byte offset, the raw bytes as written, the spec clause it
155
- violates, and what to do next. Pass `{ strict: true }` and the first one throws instead.
154
+ Every diagnostic names the field at fault, the spec clause it violates, and what to do next. One
155
+ anchored to a header field carries that field's byte offset and its raw bytes as written too. The
156
+ two about the spacing of record onsets carry neither, because the defect is a relationship between
157
+ records rather than a value sitting at an offset — they name the record instead where one record is
158
+ at fault, and the whole file where the shape is. Pass `{ strict: true }` and the first one throws
159
+ instead.
156
160
 
157
161
  **Digital and physical are two functions.** `chunk.signals[i].digital` is an `Int32Array` of
158
162
  the values as stored. `toPhysical(signal, digital)` returns a `Float64Array` in the signal's own
@@ -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.361";
112
+ export declare const VERSION = "0.4.363";
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.361';
82
+ export const VERSION = '0.4.363';
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.363
10
+
11
+ - **Corrected** the README's promise about diagnostics and widened 0.4.325's check to cover it. It
12
+ said every diagnostic carries "the field, the byte offset, the raw bytes as written, the spec
13
+ clause it violates, and what to do next". Two of them carry neither the offset nor the raw bytes:
14
+ `DISCONTINUITY_IN_CONTINUOUS_FILE` and `RECORD_ONSET_SPACING_VIOLATION` are about the spacing of
15
+ record onsets, so there is no one offset the defect sits at and no field text to quote.
16
+ - That is the right answer rather than a gap — an offset invented for them would point at a record
17
+ that is individually fine — so the sentence now says which diagnostics carry which. It also
18
+ distinguishes the two ways the first of them is raised: against the last probed record when one
19
+ record is at fault, and as a whole-file summary when the shape is, which is why not even a record
20
+ index is always available.
21
+ - The sweep now checks all five properties instead of the spec clause alone: every diagnostic names
22
+ its field and says what to do next, everything anchored to a header field carries an offset and
23
+ its raw bytes, and the two relational codes carry neither and are asserted to be reached, so the
24
+ exemption is examined rather than assumed.
25
+
26
+ ## 0.4.362
27
+
28
+ - **Added** a check over the edfcore column of the capabilities table on `comparison.md`. Seven
29
+ rows, and only one column this repository is entitled to check: the other four describe packages
30
+ nobody here controls, surveyed at a point in time, and asserting anything about them would be
31
+ asserting about someone else's release schedule. The claim under test is that every "Yes" in our
32
+ own column is true of the package as it stands.
33
+ - Worth checking because a comparison table is the most self-serving thing a project publishes and
34
+ the one a reader is least able to verify. The two rows the page itself calls load-bearing are the
35
+ two easiest to overstate, so both are demonstrated rather than asserted: random access by a
36
+ partial read counted through a recording source and landing past the middle of the file, and
37
+ EDF+D by a gap that puts record 3 at 13 seconds where the nominal grid would put it at 3.
38
+
9
39
  ## 0.4.361
10
40
 
11
41
  - **Added** a check over the error-class table on `api-errors.md`. Seven classes, each with an
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.4.361",
3
+ "version": "0.4.363",
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.361';
96
+ export const VERSION = '0.4.363';