The object exported by edgio.config.js

Hierarchy

Properties

cloudRuntime: CloudRuntime

Sets the Node.js runtime that should be used inside the cloud. By default, local runtime is used, falling back to Node.js 18 if not supported.

connector?: string

The name of the connector package corresponding to the framework your app uses, or the path to a directory that implements the connector interface.

edge_functions?: EdgeFunctions
environment_variables?: EnvironmentVariables
environments?: {
    [name: string]: Property;
}

Config overrides to be applied when deploying to specific environments.

Type declaration

hostnames: [Hostnames, ...Hostnames[]]

Min Items

1

interpolationValues?: InterpolationValues

Interpolation values that will be used for interpolation that are not supported when testing locally but are available during production.

  • Example

%{virt_dst_country} is not supported in a local development but is supported in a production to show this value locally, the following property should be set as following:

interpolationValues.virt_dst_country: 'US'

name: string
nodejsConnector?: NodejsConnectorConfig

If '@edgio/nodejs-connector' is used as the connector, this value will be used to configure it.

organization?: string

The name of the organization in Edgio to which this app should be deployed.

origins: [Origins, ...Origins[]]

Min Items

1

Max Items

10000

prerenderConcurrency?: number

This option allows to lower the number of concurrently prerendered pages. Use this option to mitigate the load on your APIs at the time of deployment.

proxyToServerlessByDefault?: boolean

Set this option to false to remove the default rule that proxies all requests to serverless. This is useful if you want to proxy all unmatched pages to different origin.

Default

true

purgeCacheOnDeploy?: boolean

This option allows to set the behavior of cache purging each time you deploy.

redirects?: Redirects
routes?: string

The path to the Edgio routes file. If omitted the default paths of routes.js, routes.ts, and routes.cjs will be used.

rules?: Rules[]
serverless?: ServerlessConfig

Options for constructing the serverless bundle.

sources?: string[]

A list of glob patterns identifying which source files should be uploaded when running edgio deploy --includeSources. This option is primarily used to share source code with Edgio support personnel for the purpose of debugging. If omitted, edgio deploy --includeSources will result in all files which are not gitignored being uploaded to Edgio.

staticAssets?: StaticAssetEntry[]

Options for serving static assets.

team?: string

The name of the team in Edgio to which this app should be deployed. This was replaced by organization property and will be removed in the future releases.

Deprecated

Use organization instead.

Generated using TypeDoc