edfcore 0.6.117 → 0.6.118

package/dist/constants.d.ts

@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
     readonly reserved: 224;
 };
 /** Published package version. Kept in sync with package.json by a test. */
-export declare const VERSION = "0.6.117";
+export declare const VERSION = "0.6.118";
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -79,5 +79,5 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
     reserved: 224,
 };
 /** Published package version. Kept in sync with package.json by a test. */
-export const VERSION = '0.6.117';
+export const VERSION = '0.6.118';
 //# sourceMappingURL=constants.js.map

package/dist/stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../src/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAe,eAAe,EAAE,MAAM,YAAY,CAAC;AAKpG;;;;;;;GAOG;AACH,wBAAuB,aAAa,CAClC,SAAS,EAAE,YAAY,EACvB,SAAS,EAAE,eAAe,EAC1B,OAAO,CAAC,EAAE,WAAW,GACpB,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,CAAC,CAuF3C"}
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../src/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAe,eAAe,EAAE,MAAM,YAAY,CAAC;AAKpG;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,YAAY,EACvB,SAAS,EAAE,eAAe,EAC1B,OAAO,CAAC,EAAE,WAAW,GACpB,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,CAAC,CA+C3C"}

package/dist/stream.js

@@ -26,7 +26,22 @@ const DEFAULT_STREAM_RECORDS = 256;
  * because the record is the only unit every signal in an EDF file shares — signals may sample at
  * different rates, so "a second of data" is a different number of samples per channel.
  */
-export async function* streamRecords(recording, selection, options) {
+export function streamRecords(recording, selection, options) {
+    /*
+     * A plain function that validates and RETURNS a generator, rather than a generator function.
+     *
+     * The body of an `async function*` does not run until the first `next()`, so every check below
+     * was deferred to the first `for await` — and `streamRecords(recording)` with no selection at all
+     * returned an object, successfully. The comment further down makes this exact argument about
+     * `resolveSignals`: "Every other selection error in the package surfaces on the spot; this one
+     * waited for data." It waited for iteration too, which is worse, because a caller who builds the
+     * stream in one place and consumes it in another gets the refusal in the second.
+     *
+     * Everything answerable from the arguments now is: the recording, the selection, the chunk size,
+     * the signal indices, and the window itself — `resolveTimeWindow` is pure over the timeline and
+     * the index, and its refusal for a probed index over a discontinuous file is about the call, not
+     * about any byte (fixed in 0.6.118).
+     */
     assertRecording(recording, 'streamRecords');
     assertSelection(selection, 'streamRecords', '{ signalIndices, startSeconds, durationSeconds } and optionally chunkRecords');
     const chunkRecords = selection.chunkRecords ?? DEFAULT_STREAM_RECORDS;
@@ -43,6 +58,10 @@ export async function* streamRecords(recording, selection, options) {
     // Every other selection error in the package surfaces on the spot; this one waited for data.
     resolveSignals(recording.header, selection.signalIndices);
     const ranges = resolveTimeWindow(recording.timeline, recording.index, selection.startSeconds, selection.durationSeconds);
+    return streamRanges(recording, selection, ranges, chunkRecords, options);
+}
+/** The iteration itself, reached only once every argument above has been accepted. */
+async function* streamRanges(recording, selection, ranges, chunkRecords, options) {
     const recordDurationTicks = recording.header.recordDurationTicks;
     for (const run of ranges) {
         let scanned = 0;

package/dist/stream.js.map

@@ -1 +1 @@
-{"version":3,"file":"stream.js","sourceRoot":"","sources":["../src/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC/F,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAGrD,uEAAuE;AACvE,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEnC;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,aAAa,CAClC,SAAuB,EACvB,SAA0B,EAC1B,OAAqB;IAErB,eAAe,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IAC5C,eAAe,CACb,SAAS,EACT,eAAe,EACf,8EAA8E,CAC/E,CAAC;IACF,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,IAAI,sBAAsB,CAAC;IACtE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,UAAU,CAClB,0EAA0E;YACxE,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI;YAClC,mFAAmF,CACtF,CAAC;IACJ,CAAC;IAED,+FAA+F;IAC/F,+FAA+F;IAC/F,2FAA2F;IAC3F,sFAAsF;IACtF,6FAA6F;IAC7F,6FAA6F;IAC7F,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IAE1D,MAAM,MAAM,GAAG,iBAAiB,CAC9B,SAAS,CAAC,QAAQ,EAClB,SAAS,CAAC,KAAK,EACf,SAAS,CAAC,YAAY,EACtB,SAAS,CAAC,eAAe,CAC1B,CAAC;IAEF,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAAC,mBAAmB,CAAC;IAEjE,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,8FAA8F;QAC9F,6FAA6F;QAC7F,IAAI,cAAuE,CAAC;QAE5E,OAAO,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAgB;gBAC3B,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,OAAO;gBAC1B,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC;aACnD,CAAC;YACF,0FAA0F;YAC1F,4FAA4F;YAC5F,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,SAAS,EACT,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,OAAO,EAAE,EACnD,OAAO,CACR,CAAC;YAEF;;;;;;;;;;;;;;;;;;;eAmBG;YACH,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;gBACjC,qBAAqB,CAAC,cAAc,EAAE;oBACpC,WAAW,EAAE,OAAO,CAAC,KAAK;oBAC1B,UAAU,EAAE,KAAK,CAAC,UAAU;iBAC7B,CAAC,CAAC;YACL,CAAC;YACD,cAAc,GAAG;gBACf,WAAW,EAAE,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC;gBAC9C,UAAU,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,aAAa,GAAG,mBAAmB;aACzE,CAAC;YAEF,MAAM,KAAK,CAAC;YACZ,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC;QAC3B,CAAC;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../src/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC/F,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAGrD,uEAAuE;AACvE,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEnC;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAC3B,SAAuB,EACvB,SAA0B,EAC1B,OAAqB;IAErB;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IAC5C,eAAe,CACb,SAAS,EACT,eAAe,EACf,8EAA8E,CAC/E,CAAC;IACF,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,IAAI,sBAAsB,CAAC;IACtE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,UAAU,CAClB,0EAA0E;YACxE,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI;YAClC,mFAAmF,CACtF,CAAC;IACJ,CAAC;IAED,+FAA+F;IAC/F,+FAA+F;IAC/F,2FAA2F;IAC3F,sFAAsF;IACtF,6FAA6F;IAC7F,6FAA6F;IAC7F,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IAE1D,MAAM,MAAM,GAAG,iBAAiB,CAC9B,SAAS,CAAC,QAAQ,EAClB,SAAS,CAAC,KAAK,EACf,SAAS,CAAC,YAAY,EACtB,SAAS,CAAC,eAAe,CAC1B,CAAC;IAEF,OAAO,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC;AAED,sFAAsF;AACtF,KAAK,SAAS,CAAC,CAAC,YAAY,CAC1B,SAAuB,EACvB,SAA0B,EAC1B,MAA8B,EAC9B,YAAoB,EACpB,OAAgC;IAEhC,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAAC,mBAAmB,CAAC;IAEjE,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,8FAA8F;QAC9F,6FAA6F;QAC7F,IAAI,cAAuE,CAAC;QAE5E,OAAO,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAgB;gBAC3B,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,OAAO;gBAC1B,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC;aACnD,CAAC;YACF,0FAA0F;YAC1F,4FAA4F;YAC5F,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,SAAS,EACT,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,OAAO,EAAE,EACnD,OAAO,CACR,CAAC;YAEF;;;;;;;;;;;;;;;;;;;eAmBG;YACH,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;gBACjC,qBAAqB,CAAC,cAAc,EAAE;oBACpC,WAAW,EAAE,OAAO,CAAC,KAAK;oBAC1B,UAAU,EAAE,KAAK,CAAC,UAAU;iBAC7B,CAAC,CAAC;YACL,CAAC;YACD,cAAc,GAAG;gBACf,WAAW,EAAE,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC;gBAC9C,UAAU,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,aAAa,GAAG,mBAAmB;aACzE,CAAC;YAEF,MAAM,KAAK,CAAC;YACZ,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC;QAC3B,CAAC;IACH,CAAC;AACH,CAAC"}

package/docs/CHANGELOG.md

@@ -6,6 +6,22 @@ alone does not tell you whether you were affected.
 edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
 defect; those are called out below.
 
+## 0.6.118
+
+- **Fixed** `streamRecords` deferring every argument check to the first `for await`.
+- The body of an `async function*` does not run until the first `next()`, so `streamRecords(recording)`
+  with no selection at all returned a generator, successfully. The function's own comment makes this
+  argument one level down, about `resolveSignals`: "Every other selection error in the package
+  surfaces on the spot; this one waited for data."
+- Waiting for iteration is worse than waiting for data, because the two happen in different places. A
+  pipeline that builds the stream in one function and consumes it in another got the refusal in the
+  second, with the arguments it names nowhere in sight; a stream that was built and then dropped
+  never reported the mistake at all.
+- It is a plain function that validates and returns a generator now. Everything answerable from the
+  arguments is answered at the call: the recording, the selection, `chunkRecords`, the signal
+  indices, and the window — `resolveTimeWindow` is pure over the timeline and the index, and its
+  refusal for a probed index over a discontinuous file is about the call rather than about any byte.
+
 ## 0.6.117
 
 - **Fixed** the two per-signal arguments the envelope module did not check, one in each direction.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edfcore",
-  "version": "0.6.117",
+  "version": "0.6.118",
   "description": "Modern, typed, zero-dependency reader for EDF, EDF+, BDF and BDF+ biosignal files. Works in browsers and Node with true random access.",
   "keywords": [
     "edf",

package/src/constants.ts

@@ -93,4 +93,4 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
 } as const;
 
 /** Published package version. Kept in sync with package.json by a test. */
-export const VERSION = '0.6.117';
+export const VERSION = '0.6.118';

package/src/stream.ts

@@ -30,11 +30,26 @@ const DEFAULT_STREAM_RECORDS = 256;
  * because the record is the only unit every signal in an EDF file shares — signals may sample at
  * different rates, so "a second of data" is a different number of samples per channel.
  */
-export async function* streamRecords(
+export function streamRecords(
   recording: EdfRecording,
   selection: StreamSelection,
   options?: ReadOptions,
 ): AsyncGenerator<EdfChunk, void, undefined> {
+  /*
+   * A plain function that validates and RETURNS a generator, rather than a generator function.
+   *
+   * The body of an `async function*` does not run until the first `next()`, so every check below
+   * was deferred to the first `for await` — and `streamRecords(recording)` with no selection at all
+   * returned an object, successfully. The comment further down makes this exact argument about
+   * `resolveSignals`: "Every other selection error in the package surfaces on the spot; this one
+   * waited for data." It waited for iteration too, which is worse, because a caller who builds the
+   * stream in one place and consumes it in another gets the refusal in the second.
+   *
+   * Everything answerable from the arguments now is: the recording, the selection, the chunk size,
+   * the signal indices, and the window itself — `resolveTimeWindow` is pure over the timeline and
+   * the index, and its refusal for a probed index over a discontinuous file is about the call, not
+   * about any byte (fixed in 0.6.118).
+   */
   assertRecording(recording, 'streamRecords');
   assertSelection(
     selection,
@@ -65,6 +80,17 @@ export async function* streamRecords(
     selection.durationSeconds,
   );
 
+  return streamRanges(recording, selection, ranges, chunkRecords, options);
+}
+
+/** The iteration itself, reached only once every argument above has been accepted. */
+async function* streamRanges(
+  recording: EdfRecording,
+  selection: StreamSelection,
+  ranges: readonly RecordRange[],
+  chunkRecords: number,
+  options: ReadOptions | undefined,
+): AsyncGenerator<EdfChunk, void, undefined> {
   const recordDurationTicks = recording.header.recordDurationTicks;
 
   for (const run of ranges) {