XpmConfig interface

Defines the xpm configuration options.

Signature

export interface XpmConfig

Remarks

Configuration options control xpm operation behavior, providing flags for safe mode overrides, installation optimizations, testing scenarios, and property overrides.

Configuration lifecycle:

1. Created from CLI arguments or programmatic API calls.
2. Merged with defaults to form complete configuration.
3. Passed through XpmContext to all xpm operations.
4. Consulted by operations to determine behavior (skip, force, dry-run).

Key configuration patterns:

• Force mode (doForce: true): Bypasses safety checks like "already installed" or "files exist". Use with caution as it can overwrite data.
• Dry run (isDryRun: true): Simulates operations without making changes, useful for testing or previewing actions.

The extensible design (additional properties allowed) supports future configuration options without breaking changes.

Properties

Property	Modifiers	Type	Description
doForce?		boolean	(Optional) Whether to force operations even when safeguards would prevent them.
doSkipIfInstalled?		boolean	(Optional) Whether to skip operations if the target is already installed.
isDryRun?		boolean	(Optional) Whether to perform a dry run without making changes.
properties?		Record<string, string | boolean | number>	(Optional) The properties map used for substitutions.

---

Generated via tsdoc2docusaurus 1.3.0-pre by API Extractor/Documenter 7.55.2.