Skip to content

Commit c441c8d

Browse files
committed
docs(dlx/manifest): correct @fileoverview Primary API list
Prior commit's overview was factually wrong — it claimed setPackageEntry and setBinaryEntry were deprecated, when in fact get() and set() are the deprecated legacy methods; the typed setPackageEntry/setBinaryEntry are current API. Keep the deprecated get/set around rather than removing them in a minor release — not enough accumulated breaking changes to justify a major bump today.
1 parent 6d43650 commit c441c8d

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

src/dlx/manifest.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
*
66
* Primary API (on {@link DlxManifest}):
77
* - `getManifestEntry(spec)` — retrieve a manifest entry by spec
8-
* - `set(name, record)` — store a raw `StoreRecord`
9-
* - `get(name)` — read a raw `StoreRecord`
8+
* - `setPackageEntry(spec, key, details)` — store npm package metadata
9+
* - `setBinaryEntry(spec, key, details)` — store binary download metadata
10+
* - `getAllPackages()` — enumerate cached package names
1011
* - `clear(name)` / `clearAll()` — eviction
1112
* - `isFresh(record, ttlMs)` — TTL check
1213
*
13-
* Legacy typed setters `setPackageEntry` and `setBinaryEntry` exist but
14-
* are deprecated; new callers should construct a `StoreRecord` and use
15-
* `set(name, record)` directly.
14+
* The bare `get(name)` / `set(name, record)` methods are deprecated
15+
* legacy shims kept for backward compatibility with pre-5.x callers.
1616
*
1717
* Features:
1818
* - TTL-based cache expiration

0 commit comments

Comments
 (0)