Documents / @faasjs/node-utils / loadConfig

Function: loadConfig()

loadConfig(root, filename, staging, logger?): FuncConfig

Resolve the staged faas.yaml config for an API file.

This walks from root to the API directory, merges every discovered faas.yaml, applies the defaults stage, annotates plugin entries with their resolved name, and normalizes relative plugin type values from the YAML file that declared them. A missing requested stage returns the resolved defaults config, and an empty YAML file contributes no config.

loadConfig only resolves and validates config; use loadPlugins when you also need plugin instances created or existing plugin instances updated.

Parameters

root

string

Project root directory used to scope config discovery.

filename

string

API filename whose directory controls nested config lookup.

staging

string

Staging name to resolve.

logger?

Logger

Optional logger used while loading config files.

Returns

FuncConfig

Resolved config for the requested staging.

Throws

If a discovered faas.yaml cannot be parsed or fails schema validation.

Example

import { loadConfig } from '@faasjs/node-utils'

const config = loadConfig(process.cwd(), '/project/src/orders/create.api.ts', 'development')