Information about the platform of the SDK and the environment it is executing.


  • PlatformData



additional?: Record<string, string>

Any additional attributes associated with the platform.

name?: string

The name of the platform the SDK is running on. For instance 'Node'.

os?: {
    arch?: string;
    name?: string;
    version?: string;

Information about the OS on which the SDK is running. Should be populated when available. Not all platforms will make this data accessible.

Type declaration

  • Optional arch?: string

    The architecture. Ideally at runtime, but may be build time if that is a constraint.

  • Optional name?: string

    The name of the OS. "MacOS", "Windows", or "Linux". If not one of those, then use the value provided by the OS.

  • Optional version?: string

    The version of the OS.

Generated using TypeDoc