Skip to main content

XpmInitTemplatePlatform type alias

Represents the supported platform identifiers for xpm init template items.

Signature

export type XpmInitTemplatePlatform = 'linux' | 'linux-x64' | 'linux-arm64' | 'win32' | 'darwin' | 'darwin-x64' | 'darwin-arm64';

Remarks

Platform identifiers filter select items based on the current execution environment, allowing templates to show only relevant options.

Platform matching strategy:

  • Generic platforms (linux, win32, darwin): match any architecture on operating system.
  • Specific platforms (linux-x64, darwin-arm64, etc.): match only the exact OS and architecture combination.

Example: An item with platforms: ["darwin-arm64"] only appears when running on Apple Silicon Macs, while platforms: ["darwin"] appears on both Intel and ARM Macs.

Common use case: Offering different toolchain options based on whether the user is on Windows, macOS Intel, macOS ARM, or Linux.


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