docs: fix incorrect RequestContext serialization method #3365
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
michaelbromley
requested changes
Feb 14, 2025
| @@ -326,7 +326,7 @@ export class ProductVideoPlugin {} | |||
|
|
|||
| Sometimes you need to pass the [RequestContext object](/reference/typescript-api/request/request-context) to the `process` function of a job, since `ctx` is required by many Vendure | |||
| service methods that you may be using inside your `process` function. However, the `RequestContext` object itself is not serializable, | |||
| so it cannot be passed directly to the `JobQueue.add()` method. Instead, you can serialize the `RequestContext` using the [`RequestContext.serialize()` | |||
| so it cannot be passed directly to the `JobQueue.add()` method. Instead, you can serialize the `RequestContext` using the ctx.serialize() method ` | |||
There was a problem hiding this comment.
This part looks incorrect. The link is not correctly formatted and the word "method" is repeated.
There was a problem hiding this comment.
Thank you for the feedback! I've made the changes. If any further adjustments are needed, please let me know. Thanks again!
|
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.
Description
Update documentation for RequestContext serialization to correctly use
ctx.serialize()instead ofRequestContext.serialize(ctx). This change resolves an issue where the documentation incorrectly referenced a static method that does not exist, leading to confusion.Breaking changes
N/A
Screenshots
N/A
Checklist
📌 Always:
👍 Most of the time: