edfcore 0.5.58 → 0.5.60
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 +45 -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.5.
|
|
112
|
+
export declare const VERSION = "0.5.60";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/docs/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,51 @@ 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.60
|
|
10
|
+
|
|
11
|
+
- **Added** the boundary six documentation pages talk about and nothing executed: `postMessage`.
|
|
12
|
+
`api-errors.md`, `diagnostics.md`, `concepts.md`, `api-reading.md`, `api-primitives.md` and
|
|
13
|
+
`data-sources.md` each tell a reader that a value crossing a worker or an iframe fails
|
|
14
|
+
`instanceof` and that `edfErrorKind` is what to branch on instead.
|
|
15
|
+
`cross-realm-errors.test.ts` executes the case those pages name — two copies of the module in one
|
|
16
|
+
dependency tree — where the object is passed by REFERENCE and only its constructor identity
|
|
17
|
+
differs. Nothing is passed by reference out of a worker: it goes through the structured clone
|
|
18
|
+
algorithm, which is a different question with different answers.
|
|
19
|
+
- `what-crosses-a-worker.test.ts` clones every value a worker would hand back, over all ten
|
|
20
|
+
`AWKWARD` shapes and a gapped file — 109 checks. Every DATA result survives and compares equal,
|
|
21
|
+
`Int32Array` samples and `bigint` ticks included, and the sweep asserts it is carrying both so a
|
|
22
|
+
pass is not a JSON round trip in disguise.
|
|
23
|
+
- Three things do not survive, and each is pinned with the workaround beside it. The record index
|
|
24
|
+
is refused outright, because `locate` is a function — `index.segments` and `index.gaps` cross
|
|
25
|
+
fine, and those are what a viewer wants. So is the recording, because a `ByteSource` has a
|
|
26
|
+
`read`; the header crosses instead. And `Object.freeze` is dropped, so the guarantee
|
|
27
|
+
`every-array-is-frozen.test.ts` pins is a within-realm one.
|
|
28
|
+
- An `EdfError` does not cross as an edfcore error at all. The algorithm keeps `name`, `message`,
|
|
29
|
+
`stack` and `cause` and drops every own property, so `code`, `field`, `byteOffset`, `diagnostic`
|
|
30
|
+
— and `edfErrorKind` itself — are gone, and `isEdfError` returns false on the far side. The
|
|
31
|
+
string beats `instanceof` for a second copy in the tree; across a `postMessage` neither works,
|
|
32
|
+
and a sender has to post the discriminator rather than the error.
|
|
33
|
+
|
|
34
|
+
## 0.5.59
|
|
35
|
+
|
|
36
|
+
- **Added** the round trip a streaming pipeline actually performs: stream a window in pieces, merge
|
|
37
|
+
the pieces, and get the window. `merge-split.test.ts` proves it for `readWindow`. `streamRecords`
|
|
38
|
+
is the other way to get a window in pieces and is different code — a `readRecords` per piece, a
|
|
39
|
+
seam check between them, and a `chunkRecords` knob that decides how many pieces there are. Its
|
|
40
|
+
docblock says the pieces must be "the same object in every respect" as a read chunk, and
|
|
41
|
+
`stream-equals-read.test.ts` checks that one piece at a time. Whether they reassemble was not
|
|
42
|
+
checked.
|
|
43
|
+
- If they do not join, the memory bound the call exists for is bought with an answer the caller
|
|
44
|
+
cannot reconstruct — which is the whole point of streaming a twelve-hour recording and then
|
|
45
|
+
running a filter over it.
|
|
46
|
+
- The stream is merged at four chunk sizes, from one piece per record to a single piece, and
|
|
47
|
+
compared against `readWindow` on the same window: the samples, the record range, the byte offset
|
|
48
|
+
and length, the exact start and duration in ticks, `precededByGap` and the diagnostics.
|
|
49
|
+
- On a discontinuous file the answer changes, correctly. The stream crosses the gap in pieces, so
|
|
50
|
+
merging all of them is refused with the message `chunks.ts` produces — and the advice that refusal
|
|
51
|
+
ends with is followed: grouped by run, each run reassembles into exactly the chunk `readWindow`
|
|
52
|
+
returns for it.
|
|
53
|
+
|
|
9
54
|
## 0.5.58
|
|
10
55
|
|
|
11
56
|
- **Added** the composition rule for `trimToWindow`: trimming to A and then to B is trimming once to
|
package/package.json
CHANGED
package/src/constants.ts
CHANGED