Skip to content
dbx tools

Function: autoConfigure()

autoConfigure<T>(config?, signal?): Promise<LakebaseConnection | undefined>

Run enabled auto-configuration steps without calling AppKit’s createApp.

Lakebase Postgres resolves when CreateAppConfig.autoConfigure is set explicitly or a native lakebase/database plugin is listed in config.plugins. signal cancels the resolution; it is combined with an internal boot timeout either way.

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T extends PluginData<PluginConstructor, unknown, string>[]

Parameters

Section titled “Parameters”

config?

Section titled “config?”

CreateAppConfig<T>

signal?

Section titled “signal?”

AbortSignal

Returns

Section titled “Returns”

Promise<LakebaseConnection | undefined>

Example

Section titled “Example”
import { appkit } from "@dbx-tools/appkit";


// Populate PGHOST / PGDATABASE / LAKEBASE_ENDPOINT without booting AppKit.
await appkit.autoConfigure({ autoConfigure: "env" });