Skip to content

Tag @rdk-moss/memory public API surface with stability tags #12

Description

@QiaolongLi1201

@rdk-moss/memory publishes with private: false but its public exports carry no TSDoc stability tags (@public / @beta / @internal). Without them, a patch release can silently break embedding hosts.

Goal: mark every declaration the package barrel (packages/dmoss-memory/src/index.ts) re-exports with @public. Types that are exported from a module but not part of the supported surface get @internal.

How (mirror the kernel): @rdk-moss/core was just tagged this way — see commit 68953fe for the exact pattern:

  1. Collect the names the barrel re-exports = the public surface.
  2. For each exported declaration in the source files, add @public to its TSDoc (or @internal if it is not reachable from the public surface).
  3. If a type is referenced by a public interface but not barrel-exported, it is part of the surface — tag it @public and add it to the barrel.

Done when: every barrel-exported declaration has a stability tag, npm run build -w @rdk-moss/memory and npm run typecheck pass, and npm run verify is green.

Good first issue: mechanical, well-scoped, no behavior change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions