Skip to content
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

[Miniflare 3] Update API docs with routes, queue*, https*, and upstream #618

Merged
merged 4 commits into from
Jun 29, 2023

Conversation

mrbbot
Copy link
Contributor

@mrbbot mrbbot commented Jun 28, 2023

This PR adds some missing API docs for #520, #566, #612, and #568. 👍

@mrbbot mrbbot requested a review from a team June 28, 2023 13:33
@changeset-bot
Copy link

changeset-bot bot commented Jun 28, 2023

⚠️ No Changeset found

Latest commit: f7d5f08

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mrbbot mrbbot changed the title Update API docs with routes, queue*, https*, and upstream [Miniflare 3] Update API docs with routes, queue*, https*, and upstream Jun 28, 2023
- `maxRetries?: number`

Maximum number of times to retry dispatching a message, if handling it throws,
or it is explicitly retired. Defaults to `2`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the docs it also says that a retry can be triggered by retryAll() being called.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured explicitly retried would cover Message#retry() or MessageBatch#retryAll().

Copy link

@petebacondarwin petebacondarwin Jun 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I know why I was confused. You have a typo: retired -> retried!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah 😂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

packages/miniflare/README.md Show resolved Hide resolved
packages/miniflare/README.md Show resolved Hide resolved
packages/miniflare/README.md Outdated Show resolved Hide resolved
packages/miniflare/README.md Outdated Show resolved Hide resolved
@mrbbot mrbbot requested a review from petebacondarwin June 28, 2023 14:09
Copy link

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Glad you retired that typo!

@mrbbot mrbbot merged commit a08bead into tre Jun 29, 2023
@mrbbot mrbbot deleted the bcoll/tre-updated-api-docs branch June 29, 2023 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants