edfcore 0.6.213 → 0.6.214

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.213";
+export declare const VERSION = "0.6.214";
 //# 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.213';
+export const VERSION = '0.6.214';
 //# sourceMappingURL=constants.js.map

package/dist/text/describe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"describe.d.ts","sourceRoot":"","sources":["../../src/text/describe.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iGAAiG;AACjG,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAmBpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE;IAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,IAAI,GAAG,SAAS,GAC/E,MAAM,CAER"}
+{"version":3,"file":"describe.d.ts","sourceRoot":"","sources":["../../src/text/describe.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iGAAiG;AACjG,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAwCpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE;IAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,IAAI,GAAG,SAAS,GAC/E,MAAM,CAER"}

package/dist/text/describe.js

@@ -38,6 +38,28 @@ export function describeValue(value) {
     if (ArrayBuffer.isView(value) || value instanceof ArrayBuffer) {
         return Object.prototype.toString.call(value).slice(8, -1);
     }
+    /*
+     * A PENDING PROMISE, which is the one object worth naming.
+     *
+     * `assertRecording` made the argument in 0.6.89 and coined the phrase: a forgotten `await` "passes
+     * the pending Promise `openEdf` returns", and a message that names an internal field instead says
+     * "nothing about the one keyword that fixes it". It then named it for the recording alone.
+     *
+     * Five async calls in this package resolve to values other guards take: `readHeader` to a header,
+     * `buildRecordIndex` to an index, `readWindow` to the chunk array, `validateRecording` to a report,
+     * `readAnnotations` to a result. So `formatHeader(readHeader(source))`,
+     * `mergeChunks(readWindow(recording, selection))` and `contiguityOf(buildRecordIndex(recording))`
+     * are all one keyword short — and every one of them was told it had passed "an object", which is
+     * true of the thing they meant to pass too.
+     *
+     * Named here rather than at each guard, because this is the module whose whole subject is a value
+     * "said in a way that cannot read as an accepted one", and roughly forty messages read their
+     * subject out of it.
+     *
+     * A property read, never a call: nothing here awaits, settles or subscribes to anything.
+     */
+    if (typeof value.then === 'function')
+        return 'a pending Promise';
     // `an object` covers an array too: a reader who passed one knows which they passed, and printing
     // its contents is how a 512-signal selection ends up on one line behind `edfcore: `.
     return typeof value === 'object' ? 'an object' : `a ${typeof value}`;

package/dist/text/describe.js.map

@@ -1 +1 @@
-{"version":3,"file":"describe.js","sourceRoot":"","sources":["../../src/text/describe.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iGAAiG;AACjG,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,cAAc,KAAK,GAAG,CAAC;IAC7D,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,cAAc,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IAC5E,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,WAAW,CAAC;IAC5C;;;;;;OAMG;IACH,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;QAC9D,OAAO,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC;IACD,iGAAiG;IACjG,qFAAqF;IACrF,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,OAAO,KAAK,EAAE,CAAC;AACvE,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAgF;IAEhF,OAAO,YAAY,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC;AAC5F,CAAC"}
+{"version":3,"file":"describe.js","sourceRoot":"","sources":["../../src/text/describe.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iGAAiG;AACjG,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,cAAc,KAAK,GAAG,CAAC;IAC7D,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,cAAc,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IAC5E,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,WAAW,CAAC;IAC5C;;;;;;OAMG;IACH,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;QAC9D,OAAO,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,OAAQ,KAA4B,CAAC,IAAI,KAAK,UAAU;QAAE,OAAO,mBAAmB,CAAC;IACzF,iGAAiG;IACjG,qFAAqF;IACrF,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,OAAO,KAAK,EAAE,CAAC;AACvE,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAgF;IAEhF,OAAO,YAAY,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC;AAC5F,CAAC"}

package/docs/CHANGELOG.md

@@ -6,6 +6,21 @@ 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.214
+
+- **Fixed** a forgotten `await` being described as "an object". 0.6.89 made the argument for the
+  recording and coined the phrase — a message that names an internal field says "nothing about the
+  one keyword that fixes it" — and `assertRecording` was the only guard that said "a pending
+  Promise".
+- Five async calls here resolve to values other guards take: `readHeader` to a header,
+  `buildRecordIndex` to an index, `readWindow` to the chunk array, `validateRecording` to a report,
+  `readAnnotations` to a result. So `mergeChunks(readWindow(recording, selection))` and
+  `contiguityOf(buildRecordIndex(recording))` are one keyword short, and each was told it had passed
+  "an object" — which is true of the thing it meant to pass too.
+- Named in `describeValue`, the module whose subject is a value "said in a way that cannot read as an
+  accepted one", so roughly forty messages get it at once. A property read, never a call: nothing
+  awaits, settles or subscribes to anything.
+
 ## 0.6.213
 
 - **Fixed** `EdfRangeError.requested` carrying whatever was refused. The field is declared a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edfcore",
-  "version": "0.6.213",
+  "version": "0.6.214",
   "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.213';
+export const VERSION = '0.6.214';

package/src/text/describe.ts

@@ -34,6 +34,27 @@ export function describeValue(value: unknown): string {
   if (ArrayBuffer.isView(value) || value instanceof ArrayBuffer) {
     return Object.prototype.toString.call(value).slice(8, -1);
   }
+  /*
+   * A PENDING PROMISE, which is the one object worth naming.
+   *
+   * `assertRecording` made the argument in 0.6.89 and coined the phrase: a forgotten `await` "passes
+   * the pending Promise `openEdf` returns", and a message that names an internal field instead says
+   * "nothing about the one keyword that fixes it". It then named it for the recording alone.
+   *
+   * Five async calls in this package resolve to values other guards take: `readHeader` to a header,
+   * `buildRecordIndex` to an index, `readWindow` to the chunk array, `validateRecording` to a report,
+   * `readAnnotations` to a result. So `formatHeader(readHeader(source))`,
+   * `mergeChunks(readWindow(recording, selection))` and `contiguityOf(buildRecordIndex(recording))`
+   * are all one keyword short — and every one of them was told it had passed "an object", which is
+   * true of the thing they meant to pass too.
+   *
+   * Named here rather than at each guard, because this is the module whose whole subject is a value
+   * "said in a way that cannot read as an accepted one", and roughly forty messages read their
+   * subject out of it.
+   *
+   * A property read, never a call: nothing here awaits, settles or subscribes to anything.
+   */
+  if (typeof (value as { then?: unknown }).then === 'function') return 'a pending Promise';
   // `an object` covers an array too: a reader who passed one knows which they passed, and printing
   // its contents is how a 512-signal selection ends up on one line behind `edfcore: `.
   return typeof value === 'object' ? 'an object' : `a ${typeof value}`;