[pull] master from koajs:master#153
Merged
Merged
Conversation
…o it) (#1978) The `app.currentContext` example assigns to the property: ```js function callSomeFunction () { app.currentContext = {} /* ctx of the middleware above */ } ``` But `currentContext` is a **getter-only** accessor (`lib/application.js`): ```js get currentContext () { if (this.ctxStorage) return this.ctxStorage.getStore() } ``` There is no setter, so assigning to it throws `TypeError: Cannot set property currentContext of #<Application> which has only a getter` in strict mode (which is the default for ES modules / class bodies). The assignment is also backwards from what the surrounding text describes — "this will **return** the current context for the request" — so the example should *read* the property, which is exactly what the adjacent v3.1.0 example does via `asyncLocalStorage.getStore()`. This changes the example to read the getter: ```js function callSomeFunction () { const ctx = app.currentContext /* ctx of the middleware above */ } ``` Docs only. ## Summary by Sourcery Documentation: - Update the `app.currentContext` documentation example to read from the getter instead of assigning to it. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Release Notes * **Documentation** * Corrected example code in Koa v3 API documentation to properly demonstrate context retrieval. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
See Commits and Changes for more details.
Created by
pull[bot] (v2.0.0-alpha.4)
Can you help keep this open source service alive? 💖 Please sponsor : )