Document type parameters for setCustomLocalAttribute() and get() - #88
Merged
Merged
Conversation
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Two documentation inconsistencies remain unresolved.
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Updates lib-context documentation for generic TypeScript context attributes and custom attribute values.
Changes:
- Documents typed
get()andsetCustomLocalAttribute()usage. - Adds generic
ContextandCustomAttributeValuedocumentation. - Updates examples to use shared attribute types.
| File | Summary | Review notes |
|---|---|---|
docs/libraries/lib-context.adoc |
Adds generic API documentation and updated examples. | Two nit findings remain: clarify compile-time-only validation wording (4 votes) and update the attributes type table to include the generic intersection (1 vote). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…ll rejects non-JSON values Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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
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.
Updates the lib-context page for enonic/xp#12398, which adds type parameters to
setCustomLocalAttribute(),get(),ContextandCustomAttributeValue.setCustomLocalAttribute<T>()constrains the stored value to the JSON-like shape ofT, compile time onlyget<Attributes>()types the attributes read back, each as optionalContext<Attributes>andCustomAttributeValue<T>described under Type DefinitionsascastShould be merged together with enonic/xp#12398.
🤖 Generated with Claude Code