Skip to main content

XpmLiquidSubstitutionsVariables.os property

Operating system information from Node.js os module.

Signature​

os: {
        EOL: string;
        arch: string;
        constants: {
            signals: Record<string, number>;
            errno: Record<string, number>;
        };
        cpus: os.CpuInfo[];
        endianness: 'BE' | 'LE';
        homedir: string;
        hostname: string;
        platform: NodeJS.Platform;
        release: string;
        tmpdir: string;
        type: string;
        version: string;
    };

Remarks​

Provides platform detection and system information for cross-platform template logic. Common uses include conditional compilation, path construction, and platform-specific configuration.

Key properties for cross-platform templates:

  • os.platform: Detect OS ('darwin', 'linux', 'win32').
  • os.arch: Detect CPU architecture ('x64', 'arm64', etc.).
  • os.EOL: Use correct line endings for generated files.
  • os.homedir: Reference user's home folder portably.

See Node.js os module documentation

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

Last updated on