@salesforce/b2c-tooling-sdk / config / resolveConfig

Function: resolveConfig()

resolveConfig(overrides, options): ResolvedB2CConfig

Defined in: packages/b2c-tooling-sdk/src/config/resolver.ts:328

Resolves configuration from multiple sources and returns a rich config object.

This is the preferred high-level API for configuration resolution. It returns a ResolvedB2CConfig object with validation methods and factory methods for creating SDK objects.

Resolution Priority

1. Explicit overrides (passed as first argument)
2. Default sources (dw.json, ~/.mobify)
3. Custom sources (via options.sources)

Example

import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';

const config = resolveConfig({
  hostname: process.env.SFCC_SERVER,
  clientId: process.env.SFCC_CLIENT_ID,
  mrtApiKey: process.env.MRT_API_KEY,
});

// Check what's available and create objects
if (config.hasB2CInstanceConfig()) {
  const instance = config.createB2CInstance();
  await instance.webdav.propfind('Cartridges');
}

if (config.hasMrtConfig()) {
  const mrtClient = config.createMrtClient({ project: 'my-project' });
}

Parameters

overrides

Partial<NormalizedConfig> = {}

Explicit configuration values (highest priority)

options

ResolveConfigOptions = {}

Resolution options

Returns

ResolvedB2CConfig

Resolved configuration with factory methods