edfcore 0.1.0 → 0.1.2
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 +10 -5
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/package.json +2 -1
- package/src/constants.ts +1 -1
package/README.md
CHANGED
|
@@ -139,8 +139,9 @@ units. There's no `{ physical: true }` option, because it would change the retur
|
|
|
139
139
|
`Float32` output (it costs about a quarter of a quantisation step on 24-bit BDF).
|
|
140
140
|
|
|
141
141
|
**Scaling can be refused.** A header that declares `digitalMinimum === digitalMaximum` defines
|
|
142
|
-
no scale: the gain is a division by zero. edfcore sets `signal.scale` to `undefined`, so
|
|
143
|
-
|
|
142
|
+
no scale: the gain is a division by zero. edfcore sets `signal.scale` to `undefined`, so reading
|
|
143
|
+
the gain without checking is a compile error, and `toPhysical` throws `EdfScalingError` at
|
|
144
|
+
runtime (it accepts any `EdfSignal`, so the call itself is not type-gated). `decodeDigital`
|
|
144
145
|
keeps working. EDFlib substitutes a gain of 1 here and returns ADC counts labelled as microvolts.
|
|
145
146
|
|
|
146
147
|
**Sample rates stay per-signal.** An EDF file can hold EEG at 256 Hz, ECG at 512 Hz and
|
|
@@ -282,7 +283,9 @@ Status-byte helpers. JSR publication.
|
|
|
282
283
|
|
|
283
284
|
## Documentation
|
|
284
285
|
|
|
285
|
-
The full documentation site lives in
|
|
286
|
+
The full documentation site lives in
|
|
287
|
+
[`website/`](https://github.com/tayal-sarthak/edfcore/tree/main/website), an Astro build with
|
|
288
|
+
twenty pages.
|
|
286
289
|
It includes a **local inspector** that opens an EDF file and shows its header, channels, events
|
|
287
290
|
and waveforms in your browser, with nothing uploaded.
|
|
288
291
|
|
|
@@ -297,7 +300,8 @@ pages. Those include a standalone primer on the EDF format itself.
|
|
|
297
300
|
|
|
298
301
|
### Deploying the site
|
|
299
302
|
|
|
300
|
-
[`vercel.json`](vercel.json) is set up so
|
|
303
|
+
[`vercel.json`](https://github.com/tayal-sarthak/edfcore/blob/main/vercel.json) is set up so
|
|
304
|
+
linking this repository to Vercel works as is.
|
|
301
305
|
**Leave the Root Directory as the repository root** and don't pick a framework preset. The
|
|
302
306
|
build compiles the library first (the site imports `edfcore` from the parent package), then
|
|
303
307
|
builds the site into `website/dist`.
|
|
@@ -311,7 +315,8 @@ like bugs and are not (the pinned scaling expression, `readWindow` always return
|
|
|
311
315
|
`scale` being `undefined` rather than fabricated) are documented on the site under
|
|
312
316
|
*Background → Design decisions*.
|
|
313
317
|
|
|
314
|
-
- [`tests/README.md`](tests/README.md) covers
|
|
318
|
+
- [`tests/README.md`](https://github.com/tayal-sarthak/edfcore/blob/main/tests/README.md) covers
|
|
319
|
+
how the suite builds every fixture in memory,
|
|
315
320
|
and why no binaries are committed.
|
|
316
321
|
|
|
317
322
|
## License
|
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.1.
|
|
112
|
+
export declare const VERSION = "0.1.2";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "edfcore",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
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",
|
|
@@ -69,6 +69,7 @@
|
|
|
69
69
|
"format": "biome format --write .",
|
|
70
70
|
"check": "npm run lint && npm run typecheck && npm run test",
|
|
71
71
|
"corpus:fetch": "node scripts/fetch-corpus.mjs",
|
|
72
|
+
"release": "node scripts/release.mjs",
|
|
72
73
|
"prepublishOnly": "npm run check && npm run build"
|
|
73
74
|
},
|
|
74
75
|
"publishConfig": {
|
package/src/constants.ts
CHANGED