Skip to main content

Function: defineConfig()

defineConfig(config): NubbinConfig

Defined in: defineConfig.ts:20

Types a nubbin.config.ts as it is written. It returns its argument untouched — the call adds no behaviour, only the annotation that makes an editor complete the four fields and a typecheck reject a wrong one before any command runs.

Parameters​

config​

NubbinConfig

The config object, checked against NubbinConfig by this call.

Returns​

NubbinConfig

The same object, by reference. Nothing is copied, frozen or validated at runtime; the CLI checks what a config file exported when it loads it.

Example​

import { defineConfig } from "@nubbin/cli";

export default defineConfig({ catalog, registry, store, document });