-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expose getFetchState function #14021
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
Open
matthewp
wants to merge
4
commits into
v7
Choose a base branch
from
docs/expose-get-fetch-state
base: v7
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+33
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
a71e7ff
Document getFetchState() in astro/hono reference
matthewp 9caf6f0
Add Since tag for getFetchState()
matthewp 8ab47c8
Update src/content/docs/en/reference/experimental-flags/advanced-rout…
matthewp ae6f21b
Update src/content/docs/en/reference/experimental-flags/advanced-rout…
matthewp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -478,6 +478,39 @@ export default app; | |||||
|
|
||||||
| The `astro/hono` module exports the same handler names as `astro/fetch` (`astro`, `pages`, `middleware`, `actions`, `sessions`, `redirects`, `cache`, `i18n`, `trailingSlash`), but each returns a Hono middleware function. This lets you mix Astro handlers with any Hono middleware from the ecosystem. | ||||||
|
|
||||||
| The `astro/hono` module also exports the following helpers. | ||||||
|
|
||||||
| ### `getFetchState()` | ||||||
|
|
||||||
| <p> | ||||||
|
|
||||||
| **Type:** <code>(context: HonoContext) => <a href="#fetchstate">FetchState</a></code><br /> | ||||||
| <Since v="7.0.0" /> | ||||||
| </p> | ||||||
|
|
||||||
| Retrieves or lazily creates a [`FetchState`](#fetchstate) from a Hono context object. This is the same function used internally by all the Astro Hono middleware wrappers, and it ensures a single `FetchState` instance is shared across all middleware for a given request. | ||||||
|
|
||||||
| Use `getFetchState()` when writing custom Hono middleware that needs to read or modify Astro's per-request state (e.g. `locals`, `cookies`, `routeData`): | ||||||
|
|
||||||
| ```ts title="src/app.ts" | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We might want to use the default filename here:
Suggested change
|
||||||
| import { Hono } from 'hono'; | ||||||
| import { getFetchState, pages } from 'astro/hono'; | ||||||
|
|
||||||
| const app = new Hono(); | ||||||
|
|
||||||
| app.use(async (context, next) => { | ||||||
| const state = getFetchState(context); | ||||||
| state.locals.message = 'Hello from custom middleware'; | ||||||
| await next(); | ||||||
| }); | ||||||
|
|
||||||
| app.use(pages()); | ||||||
|
|
||||||
| export default app; | ||||||
| ``` | ||||||
|
|
||||||
| This gives third-party packages and custom middleware the same access to Astro's request state that the built-in Hono handlers have, ensuring both `astro/fetch` and `astro/hono` have equal extensibility. | ||||||
|
|
||||||
| ## Cloudflare adapter | ||||||
|
|
||||||
| The [`@astrojs/cloudflare`](/en/guides/integrations-guide/cloudflare/) adapter provides companion handlers that apply Cloudflare-specific setup to your advanced routing pipeline. These handlers configure session KV binding injection, static asset serving via the `ASSETS` binding, `Astro.locals.cfContext`, client address from the `cf-connecting-ip` header, `waitUntil`, and prerendered error page fetching. | ||||||
|
|
||||||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.