Skip to content
View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / clients / resolveScapiOrOcapi

Function: resolveScapiOrOcapi()

resolveScapiOrOcapi(opts): "ocapi" | "scapi"

Defined in: packages/b2c-tooling-sdk/src/clients/scapi-backend-utils.ts:224

Resolves a user preference + config availability into a concrete backend choice.

  • Explicit 'ocapi' always returns 'ocapi'.
  • Explicit 'scapi' requires SCAPI config and throws if missing.
  • 'auto' returns 'scapi' if SCAPI config is available, otherwise 'ocapi'.

Throws an error with the domain name in the message when explicit SCAPI is requested without the required configuration. The error identifies release 26.8 as the current platform capability baseline so it can be revised when SCAPI adds support.

Parameters

opts

ResolveBackendOptions

Returns

"ocapi" | "scapi"

Released under the Apache-2.0 License.