docs: refresh stale auth-API references in JSDoc#84
Open
tomaspozo wants to merge 1 commit into
Open
Conversation
The allow→auth / 'always'→'none' / 'public'→'publishable' / authType→authMode rename was already applied across the prose docs, but a few JSDoc reference comments (which feed the typedoc API reference) still used the old names: - AuthResult doc: "public" → "publishable" - keyName doc: "always" → "none" - Elysia plugin @example blocks: allow: 'user' → auth: 'user'
commit: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The
allow→auth/'always'→'none'/'public'→'publishable'/authType→authModerename (landed in #48) was already applied across the prose docs andSKILL.md, but a few JSDoc reference comments — which feed the typedoc-generated API reference — still used the old names.Changes
src/types.ts—AuthResultdoc:"public"→"publishable";keyNamedoc:"always"→"none"src/adapters/elysia/plugin.ts— both@exampleblocks:allow: 'user'→auth: 'user'Not touched (intentional)
verify-credentials.test.ts,with-supabase.test.ts) that exercise the legacyallowoption on purposeallowbackward-compat wiring (create-supabase-context.ts,deprecation.ts) andMIGRATION.mdJSDoc-comment-only edits — no compilation impact.
🤖 Generated with Claude Code