Skip to content
CtrlK

defineArdoConfig

On this page

Contextually type configuration literals, including nested options.

import { defineArdoConfig } from "ardo/config"

defineArdoConfig(config: ArdoPluginOptions): ArdoPluginOptions
defineArdoConfig(config: Promise<ArdoPluginOptions>): Promise<ArdoPluginOptions>
defineArdoConfig(config: (environment: ConfigEnv) => ArdoPluginOptions | Promise<ArdoPluginOptions>): (environment: ConfigEnv) => ArdoPluginOptions | Promise<ArdoPluginOptions>
defineArdoConfig(config: ArdoProjectConfigExport): ArdoProjectConfigExport

Overload

defineArdoConfig(config: ArdoPluginOptions): ArdoPluginOptions

Parameters

NameTypeRequired
configArdoPluginOptionsYes

Returns

ArdoPluginOptions

Overload

defineArdoConfig(config: Promise<ArdoPluginOptions>): Promise<ArdoPluginOptions>

Parameters

NameTypeRequired
configPromise<ArdoPluginOptions>Yes

Returns

Promise<ArdoPluginOptions>

Overload

defineArdoConfig(config: (environment: ConfigEnv) => ArdoPluginOptions | Promise<ArdoPluginOptions>): (environment: ConfigEnv) => ArdoPluginOptions | Promise<ArdoPluginOptions>

Parameters

NameTypeRequired
config(environment: ConfigEnv) => ArdoPluginOptions | Promise<ArdoPluginOptions>Yes

Returns

(environment: ConfigEnv) => ArdoPluginOptions | Promise<ArdoPluginOptions>

Overload

defineArdoConfig(config: ArdoProjectConfigExport): ArdoProjectConfigExport

Parameters

NameTypeRequired
configArdoProjectConfigExportYes

Returns

ArdoProjectConfigExport