Skip to content

Config: LoadPalamedesConfigOptions

Functions, types, and exports for Config: LoadPalamedesConfigOptions.

Page outline
import type { LoadPalamedesConfigOptions } from "@palamedes/config"

type LoadPalamedesConfigOptions = {
    /**
     * Directory where config discovery starts and that a relative `configPath`
     * resolves from. Defaults to the current working directory.
     */
    projectRoot?: string;
    /** Explicit config file, absolute or relative to `projectRoot`. */
    configPath?: string;
    skipValidation?: boolean;
};

Properties

NameTypeRequiredDescription
projectRootstringNoDirectory where config discovery starts and that a relative configPath
resolves from. Defaults to the current working directory.
configPathstringNoExplicit config file, absolute or relative to projectRoot.
skipValidationbooleanNo

Source entry on GitHub

Last updated: November 1, 2026