edfcore 0.6.17 → 0.6.18

package/README.md

@@ -52,11 +52,15 @@ In Node, swap the source and nothing else changes:
 import { openEdf, getSignal, readWindow, toPhysical } from 'edfcore';
 import { fileSource } from 'edfcore/node';
 
-const recording = await openEdf(await fileSource('./overnight.edf'));
+const source = await fileSource('./overnight.edf');
+const recording = await openEdf(source);
 
 console.log(recording.header.variant);                  // 'EDF+C'
 console.log(recording.header.signals.map((s) => s.label));
 console.log(recording.timeline.spanSeconds);
+
+// fileSource opens a descriptor and closing it is yours.
+await source.close();
 ```
 
 Reading those ten seconds out of a twelve-hour recording reads roughly ten seconds' worth of
@@ -198,7 +202,8 @@ read.
 import { openEdf, readWindow, resolveTimeWindow } from 'edfcore';
 import { fileSource } from 'edfcore/node';
 
-const recording = await openEdf(await fileSource('./overnight.edf'));
+const source = await fileSource('./overnight.edf');
+const recording = await openEdf(source);
 
 // resolveTimeWindow is pure and does no I/O, so you can audit the cost first.
 const ranges = resolveTimeWindow(recording.timeline, recording.index, 3600, 30);
@@ -208,6 +213,8 @@ const chunks = await readWindow(recording, {
   startSeconds: 3600,
   durationSeconds: 30,
 });
+
+await source.close();
 ```
 
 Chunks are record-aligned and may be slightly wider than requested. `trimToWindow()` narrows

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

package/docs/CHANGELOG.md

@@ -6,6 +6,20 @@ 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.18
+
+- **Fixed** the same thing in the two files 0.6.17 could not see. `README.md` and `AGENTS.md` are
+  not pages the docs collection loads, so the sweep over the site missed both — and the README is
+  what npm renders, which makes its snippets the ones most people meet first. Two of them opened a
+  `fileSource` inline and never closed it.
+- **Added** a seventh entry to the mistakes list in `AGENTS.md`: a `fileSource` holds a descriptor
+  and closing it is yours. It names the shape that makes closing impossible —
+  `await openEdf(await fileSource(path))` — and says why `blobSource` and `byteSource` need none of
+  it, so the canonical snippet above it is not read as an omission.
+- `a-file-you-open-is-a-file-you-close.test.ts` sweeps both files now, and ignores a mention inside
+  a comment: that snippet says `// or fileSource() from 'edfcore/node'` beside a `blobSource`,
+  which is prose about an alternative rather than a file being opened.
+
 ## 0.6.17
 
 - **Fixed** `await source.close()` not compiling. `api-sources.md` tells a reader "After that,

package/package.json

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