API Reference / @gtkx/config / index / DeployNodeOptions

Type Alias: DeployNodeOptions

DeployNodeOptions = object

Defined in: packages/config/src/deploy.ts:200

The deploy.node options: where the Node.js runtime bundled with the application comes from, the version it is expected to be, whether its binary is stripped, and whether the launcher enables the compile cache.

Properties

path?

optional path?: string

Defined in: packages/config/src/deploy.ts:206

Node.js executable path relative to the project root, required when source is path.

---

shouldStrip?

optional shouldStrip?: boolean

Defined in: packages/config/src/deploy.ts:208

Strip the runtime when its architecture matches the host and strip is available. Defaults to true.

---

shouldUseCompileCache?

optional shouldUseCompileCache?: boolean

Defined in: packages/config/src/deploy.ts:210

Enable Node.js compile caching in the generated launcher. Defaults to true.

---

source?

optional source?: "download" | "host" | "path"

Defined in: packages/config/src/deploy.ts:202

Runtime source: an official download, the running Node.js executable, or path. Defaults to download.

---

version?

optional version?: string

Defined in: packages/config/src/deploy.ts:204

Expected Node.js version. Downloaded runtimes default to exactly 26.8.2 when omitted.