Skip to content

fix wrong persist value in getPlatformProxy docs #22008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 29, 2025

Conversation

dario-piotrowicz
Copy link
Member

Summary

getPlatfrormProxy accepts a persist option of the shape boolean | { path: string } but in the docs
there is a mention of setting persist directly to a string, this PR is simply addressing this incorrect mention


Fixes #22007

Copy link
Contributor

hyperlint-ai bot commented Apr 28, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Corrected the documentation for the persist option in the getPlatformProxy function to reflect its proper usage.

  • Updated the persist option description to accept an object instead of a string.
  • Clarified the example usage of the persist option in the documentation.

Modified Files

  • src/content/docs/workers/wrangler/api.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions github-actions bot added the product:workers Related to Workers product label Apr 28, 2025
@dario-piotrowicz
Copy link
Member Author

Thanks a lot for the approval @ToriLindsay 😄

@dario-piotrowicz dario-piotrowicz merged commit 5c1c1dd into production Apr 29, 2025
13 checks passed
@dario-piotrowicz dario-piotrowicz deleted the dario/getplatformproxy-wrong-path-str branch April 29, 2025 21:56
GregBrimble pushed a commit that referenced this pull request May 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:workers Related to Workers product size/xs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

getPlatformProxy "persist" docs are missleading
3 participants