netlify-edge

netlifyEdgeAdapter

export declare function netlifyEdgeAdapter(
  opts?: NetlifyEdgeAdapterOptions,
): any;

Parameter	Type	Description
opts	NetlifyEdgeAdapterOptions	(Optional)

Returns:

any

Edit this section

NetlifyEdgeAdapterOptions

export interface NetlifyEdgeAdapterOptions extends ServerAdapterOptions

Extends: ServerAdapterOptions

Property	Type	Description
excludedPath?	string \| string[]	(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
functionRoutes?	boolean	(Optional) Determines if the build should generate the edge functions declarations `manifest.json` file. https://docs.netlify.com/edge-functions/declarations/ Defaults to `true`.
staticPaths?	string[]	(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.

Property

Modifiers

Type

Description

excludedPath?

string | string[]

(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

functionRoutes?

boolean

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

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

Defaults to true.

staticPaths?

string[]

(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.

Edit this section