Skip to content

docs(api): clarify helpers and deprecate MethodsOnly - #67

Merged
antelm-dev merged 1 commit into
mainfrom
codex/docs-api-clarifications
Aug 11, 2026
Merged

docs(api): clarify helpers and deprecate MethodsOnly#67
antelm-dev merged 1 commit into
mainfrom
codex/docs-api-clarifications

Conversation

@antelm-dev

Copy link
Copy Markdown
Owner

Summary

  • call out that handleOnce and listenOnce are process-scoped directly in the API table
  • position defineChannel as an extension point for wrapper authors and recommend the preset helpers for regular consumers
  • deprecate MethodsOnly without removing the public export, and document the migration to a project-local mapped type

Impact

This is a documentation and type-metadata-only change. Runtime behavior and the package export map remain unchanged.

Validation

  • pnpm check
  • 8 test files passed
  • 117 tests passed

Closes #58
Closes #59
Closes #60

@antelm-dev
antelm-dev marked this pull request as ready for review August 11, 2026 13:12
@antelm-dev
antelm-dev merged commit 67cf500 into main Aug 11, 2026
14 checks passed
@antelm-dev
antelm-dev deleted the codex/docs-api-clarifications branch August 11, 2026 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant