edfcore 0.4.110 → 0.4.112
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 +24 -0
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/docs/CHANGELOG.md +18 -0
- package/package.json +1 -1
- package/src/constants.ts +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# edfcore
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/edfcore)
|
|
4
|
+
[](https://edfcore.vercel.app/api.json)
|
|
5
|
+
[](https://www.npmjs.com/package/edfcore)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
|
|
3
8
|
edfcore reads EDF, EDF+, BDF and BDF+ biosignal files in TypeScript, in the browser and in
|
|
4
9
|
Node. Real random access, no dependencies.
|
|
5
10
|
|
|
@@ -289,6 +294,25 @@ the reason to trust the reader.
|
|
|
289
294
|
|
|
290
295
|
---
|
|
291
296
|
|
|
297
|
+
## API surface
|
|
298
|
+
|
|
299
|
+
| | |
|
|
300
|
+
|---|---|
|
|
301
|
+
| Entry points | 3 — `edfcore`, `edfcore/node`, `edfcore/validate` |
|
|
302
|
+
| Functions, classes and constants | 78 |
|
|
303
|
+
| Public types | 64 |
|
|
304
|
+
| Diagnostic codes | 46 |
|
|
305
|
+
| CLI commands | 6 |
|
|
306
|
+
|
|
307
|
+
Every number above is asserted against the package by
|
|
308
|
+
[`tests/integration/api-surface.test.ts`](tests/integration/api-surface.test.ts) — it counts the
|
|
309
|
+
real exports, renders the real `--help`, and fails when this table drifts from either. The
|
|
310
|
+
`exports` badge at the top reads [`/api.json`](https://edfcore.vercel.app/api.json), which the
|
|
311
|
+
documentation site generates at deploy time by importing the three published entry points and
|
|
312
|
+
counting them, so it needs no maintenance at all.
|
|
313
|
+
|
|
314
|
+
---
|
|
315
|
+
|
|
292
316
|
## Roadmap
|
|
293
317
|
|
|
294
318
|
**0.1 — reads everything, lies about nothing.** All six variants, the primitive/I/O/convenience
|
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.4.
|
|
112
|
+
export declare const VERSION = "0.4.112";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/docs/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,24 @@ 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.4.112
|
|
10
|
+
|
|
11
|
+
- **Added** shields.io badges to the README — npm version, exports, types and licence — and
|
|
12
|
+
`/api.json` on the documentation site to back the exports one.
|
|
13
|
+
- The count is generated, not written. The site imports the three published entry points at deploy
|
|
14
|
+
time and counts them, so the badge follows the package without anyone editing a number. Three of
|
|
15
|
+
the four badges are served from npm's own metadata and update themselves the same way.
|
|
16
|
+
|
|
17
|
+
## 0.4.111
|
|
18
|
+
|
|
19
|
+
- **Added** an "API surface" table to the README: three entry points, 78 functions, classes and
|
|
20
|
+
constants, 64 public types, 46 diagnostic codes and 6 CLI commands.
|
|
21
|
+
- Every number is asserted by `tests/integration/api-surface.test.ts` rather than written down and
|
|
22
|
+
trusted. It imports the three entry points and counts them, reads the disposition registry every
|
|
23
|
+
known code must appear in, and renders the CLI's own `--help` to count the commands. A count in
|
|
24
|
+
prose is exactly the claim that went stale unnoticed in the site footer for three minor series,
|
|
25
|
+
so this one ships with the check that catches it.
|
|
26
|
+
|
|
9
27
|
## 0.4.110
|
|
10
28
|
|
|
11
29
|
- **Added** a docblock to `TalRegionParse` saying why it always carries both halves. A malformed
|
package/package.json
CHANGED
package/src/constants.ts
CHANGED