ContextQMD
Back to Qwik

@builder.io/qwik-city/vite/netlify-edge API Reference

packages/docs/src/routes/api/qwik-city-vite-netlify-edge/index.mdx

1.7.12.1 KB
Original Source

API › @builder.io/qwik-city/vite/netlify-edge

<h2 id="netlifyedgeadapter">netlifyEdgeAdapter</h2>
typescript
export declare function netlifyEdgeAdapter(
  opts?: NetlifyEdgeAdapterOptions,
): any;
<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

opts

</td><td>

NetlifyEdgeAdapterOptions

</td><td>

(Optional)

</td></tr> </tbody></table>

Returns:

any

Edit this section

<h2 id="netlifyedgeadapteroptions">NetlifyEdgeAdapterOptions</h2>
typescript
export interface NetlifyEdgeAdapterOptions extends ServerAdapterOptions

Extends: ServerAdapterOptions

<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

excludedPath?

</td><td> </td><td>

string | string[]

</td><td>

(Optional) Manually add path pattern that should be excluded from the edge function routes that are created by the 'manifest.json' file.

If not specified, the following paths are excluded by default:

  • /build/* - /favicon.ico - /robots.txt - /mainifest.json - /~partytown/* - /service-worker.js - /sitemap.xml

https://docs.netlify.com/edge-functions/declarations/\#declare-edge-functions-in-netlify-toml

</td></tr> <tr><td>

functionRoutes?

</td><td> </td><td>

boolean

</td><td>

(Optional) Determines if the build should generate the edge functions declarations manifest.json file.

https://docs.netlify.com/edge-functions/declarations/

Defaults to true.

</td></tr> <tr><td>

staticPaths?

</td><td> </td><td>

string[]

</td><td>

(Optional) Manually add pathnames that should be treated as static paths and not SSR. For example, when these pathnames are requested, their response should come from a static file, rather than a server-side rendered response.

</td></tr> </tbody></table>

Edit this section