Skip to content

API reference / @backpack/config / defineConfig

Function: defineConfig()

Call Signature

ts
function defineConfig<TConfig>(config): DeepPartial<TConfig>;

Helper function for defining configs.

Type Parameters

Type Parameter
TConfig

Parameters

ParameterType
configDeepPartial<TConfig>

Returns

DeepPartial<TConfig>

Call Signature

ts
function defineConfig<TConfig, TContext>(configProvider): (context) => Promise<DeepPartial<TConfig>>;

Helper function for defining configs.

Type Parameters

Type Parameter
TConfig
TContext

Parameters

ParameterType
configProvider(context) => Promise<DeepPartial<TConfig>>

Returns

ts
(context): Promise<DeepPartial<TConfig>>;

Parameters

ParameterType
contextTContext

Returns

Promise<DeepPartial<TConfig>>

Call Signature

ts
function defineConfig<TConfig>(configProvider): (context) => Promise<DeepPartial<TConfig>>;

Helper function for defining configs.

Type Parameters

Type Parameter
TConfig

Parameters

ParameterType
configProvider(context) => Promise<DeepPartial<TConfig>>

Returns

ts
(context): Promise<DeepPartial<TConfig>>;

Parameters

ParameterType
contextany

Returns

Promise<DeepPartial<TConfig>>