Skip to content

Commit

Permalink
add partial docs for astro:build:ssr options
Browse files Browse the repository at this point in the history
`entryPoints` added in withastro/astro#7220 so v2.7.0
`middlewareEntryPoint` added in withastro/astro#7532 so 2.8.0
  • Loading branch information
ArmandPhilippot committed Jan 29, 2025
1 parent d407744 commit 985ed43
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions src/content/docs/en/reference/integrations-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1086,6 +1086,72 @@ export default {
}) => void | Promise<void>;
```
#### `manifest` option
<p>
**Type:** `SerializedSSRManifest`
</p>
{/* I still need to figure this one out. */}
```js
export default {
name: 'my-integration',
hooks: {
'astro:build:ssr': ({ manifest }) => {
// still not sure about the use case...
},
},
}
```
#### `entryPoints` option
<p>
**Type:** `Map<IntegrationRouteData, URL>`<br />
<Since v="2.7.0" />
</p>
A `Map` with a list of `IntegrationRouteData` as key and the physical file URL as value.
```js
export default {
name: 'my-integration',
hooks: {
'astro:build:ssr': ({ entryPoints }) => {
entryPoints.forEach((url) => {
console.log(url.href);
});
},
},
}
```
#### `middlewareEntryPoint` option
<p>
**Type:** `URL | undefined`<br />
<Since v="2.8.0" />
</p>
Exposes the middleware file path.
```js
export default {
name: 'my-integration',
hooks: {
'astro:build:ssr': ({ middlewareEntryPoint }) => {
if (middlewareEntryPoint) {
// do some operations
}
},
},
}
```
### `astro:build:done`
**Previous hook:** [`astro:build:ssr`](#astrobuildssr)
Expand Down

0 comments on commit 985ed43

Please sign in to comment.