edfcore 0.4.390 → 0.4.392
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/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/docs/CHANGELOG.md +35 -0
- package/package.json +1 -1
- package/src/constants.ts +1 -1
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.392";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/docs/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,41 @@ 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.392
|
|
10
|
+
|
|
11
|
+
- **Added** a check that the docblocks reach the published types, which five other checks quietly
|
|
12
|
+
assume. `config/tsconfig.build.json` sets `removeComments: false`, and that one line is why the
|
|
13
|
+
module docblock of `src/index.ts` is the hover text an editor shows over an import, and why
|
|
14
|
+
`readme-status.test.ts`, `node-floor.test.ts`, `module-layers.test.ts`, `file-references.test.ts`
|
|
15
|
+
and `next-clause.test.ts` each say some version of "this comment ships, so a stale one is stale
|
|
16
|
+
in the package".
|
|
17
|
+
- Nothing asserted it. Flip the flag and all five keep passing — they read `src/`, and the claim
|
|
18
|
+
they draw from it is about `dist/`. What changes is that the published `.d.ts` files lose every
|
|
19
|
+
line of documentation, an editor shows a bare signature on hover, and the package's reasoning
|
|
20
|
+
about itself stops being visible to anyone who installs it.
|
|
21
|
+
- The setting is asserted and then the artifact is checked rather than the setting: a distinctive
|
|
22
|
+
sentence from three source docblocks has to be present, verbatim, in the `.d.ts` built from it.
|
|
23
|
+
`removeComments` is one of several ways to lose them, and reading the file catches the rest.
|
|
24
|
+
|
|
25
|
+
## 0.4.391
|
|
26
|
+
|
|
27
|
+
- **Added** a check that the defaults the option tables print are the defaults the code applies.
|
|
28
|
+
Four reference pages carry a `Default` column, and between them they publish the numbers almost
|
|
29
|
+
every caller gets by passing nothing: 256 MiB for `maxMaterializeBytes`, 1 MiB blocks and a
|
|
30
|
+
64 MiB budget for `cachedSource`, four in-flight requests for `httpSource`.
|
|
31
|
+
- They are observed rather than imported. Comparing the tables with `DEFAULT_MAX_MATERIALIZE_BYTES`
|
|
32
|
+
would pass just as happily on a release where that constant is no longer what resolves — the
|
|
33
|
+
failure `options.ts` opens by describing, where the budget is resolved in six modules across the
|
|
34
|
+
stack. So the budget is read off the `EdfBudgetError` a refused allocation carries, the block
|
|
35
|
+
size off the read the cache issues, the LRU budget off the clamp it applies to an oversized
|
|
36
|
+
block, and the concurrency off the peak number of requests in flight.
|
|
37
|
+
- Finding out what 256 MiB is costs a few hundred bytes: the budget is checked against the header
|
|
38
|
+
geometry before anything is allocated, so the fixture is a header that declares 4,000 records of
|
|
39
|
+
120,000 bytes over a source that fabricates them.
|
|
40
|
+
- The last check is the closure. Every numeric cell in those `Default` columns has to be one of the
|
|
41
|
+
values observed here, so a newly documented number either gets an observation or fails and names
|
|
42
|
+
the page it is on.
|
|
43
|
+
|
|
9
44
|
## 0.4.390
|
|
10
45
|
|
|
11
46
|
- **Changed** the CLI's print cap from a literal repeated at four call sites to one
|
package/package.json
CHANGED
package/src/constants.ts
CHANGED