@tauri-apps/plugin-os

Provides operating system-related utility methods and properties.

Type Aliases

Arch

type Arch =
  | "x86"
  | "x86_64"
  | "arm"
  | "aarch64"
  | "mips"
  | "mips64"
  | "powerpc"
  | "powerpc64"
  | "riscv64"
  | "s390x"
  | "sparc64";

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L51

A string describing the specific operating system architecture in use, as returned by arch.

---

Family

type Family = "unix" | "windows";

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L118

A string describing the operating system family, as returned by family.

---

OsType

type OsType = "linux" | "windows" | "macos" | "ios" | "android";

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L46

A coarse-grained operating system category, as returned by type.

---

Platform

type Platform =
  | "linux"
  | "macos"
  | "ios"
  | "freebsd"
  | "dragonfly"
  | "netbsd"
  | "openbsd"
  | "solaris"
  | "android"
  | "windows";

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L31

A string describing the specific operating system in use, as returned by platform.

Functions

arch()

function arch(): Arch;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L162

Returns the current operating system architecture. Possible values are 'x86', 'x86_64', 'arm', 'aarch64', 'mips', 'mips64', 'powerpc', 'powerpc64', 'riscv64', 's390x', 'sparc64'.

Returns

Arch

The operating system architecture.

Example

import { arch } from '@tauri-apps/plugin-os';
const archName = arch();

Since

2.0.0

---

eol()

function eol(): string;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L78

Returns the operating system-specific end-of-line marker.

• \n on POSIX
• \r\n on Windows

Returns

string

The end-of-line marker for the current platform.

Example

import { eol } from '@tauri-apps/plugin-os';
const eolChar = eol();

Since

2.0.0

---

exeExtension()

function exeExtension(): string;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L177

Returns the file extension, if any, used for executable binaries on this platform. Possible values are 'exe' and '' (empty string).

Returns

string

The file extension used for executable binaries on this platform.

Example

import { exeExtension } from '@tauri-apps/plugin-os';
const exeExt = exeExtension();

Since

2.0.0

---

family()

function family(): Family;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L131

Returns the current operating system family. Possible values are 'unix', 'windows'.

Returns

Family

The operating system family.

Example

import { family } from '@tauri-apps/plugin-os';
const family = family();

Since

2.0.0

---

hostname()

function hostname(): Promise<string | null>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L210

Returns the host name of the operating system.

Returns

Promise<string | null>

A promise resolving to the host name of the operating system.

Example

import { hostname } from '@tauri-apps/plugin-os';
const hostname = await hostname();

Since

2.0.0

---

locale()

function locale(): Promise<string | null>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L195

Returns a String with a BCP-47 language tag inside. If the locale couldn’t be obtained, null is returned instead.

Returns

Promise<string | null>

A promise resolving to the BCP-47 language tag, or null if it could not be obtained.

Example

import { locale } from '@tauri-apps/plugin-os';
const locale = await locale();
if (locale) {
   // use the locale string here
}

Since

2.0.0

---

platform()

function platform(): Platform;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L96

Returns a string describing the specific operating system in use. The value is set at compile time. Possible values are 'linux', 'macos', 'ios', 'freebsd', 'dragonfly', 'netbsd', 'openbsd', 'solaris', 'android', 'windows'

Returns

Platform

The platform name.

Example

import { platform } from '@tauri-apps/plugin-os';
const platformName = platform();

Since

2.0.0

---

type()

function type(): OsType;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L146

Returns the current operating system type. Returns 'linux' on Linux, 'macos' on macOS, 'windows' on Windows, 'ios' on iOS and 'android' on Android.

Returns

OsType

The operating system type.

Example

import { type } from '@tauri-apps/plugin-os';
const osType = type();

Since

2.0.0

---

version()

function version(): string;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/os/guest-js/index.ts#L111

Returns the current operating system version.

Returns

string

The operating system version.

Example

import { version } from '@tauri-apps/plugin-os';
const osVersion = version();

Since

2.0.0