@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";

Defined in: plugins/os/guest-js/index.ts:42

---

Family

type Family = "unix" | "windows";

Defined in: plugins/os/guest-js/index.ts:97

---

OsType

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

Defined in: plugins/os/guest-js/index.ts:40

---

Platform

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

Defined in: plugins/os/guest-js/index.ts:28

Functions

arch()

function arch(): Arch;

Defined in: plugins/os/guest-js/index.ts:138

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

Returns

Arch

Example

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

Since

2.0.0

---

eol()

function eol(): string;

Defined in: plugins/os/guest-js/index.ts:62

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

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

Returns

string

Since

2.0.0

---

exeExtension()

function exeExtension(): string;

Defined in: plugins/os/guest-js/index.ts:152

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

Returns

string

Example

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

Since

2.0.0

---

family()

function family(): Family;

Defined in: plugins/os/guest-js/index.ts:109

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

Returns

Family

Example

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

Since

2.0.0

---

hostname()

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

Defined in: plugins/os/guest-js/index.ts:181

Returns the host name of the operating system.

Returns

Promise<string | null>

Example

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

---

locale()

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

Defined in: plugins/os/guest-js/index.ts:169

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>

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;

Defined in: plugins/os/guest-js/index.ts:79

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

Example

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

Since

2.0.0

---

type()

function type(): OsType;

Defined in: plugins/os/guest-js/index.ts:123

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

Example

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

Since

2.0.0

---

version()

function version(): string;

Defined in: plugins/os/guest-js/index.ts:93

Returns the current operating system version.

Returns

string

Example

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

Since

2.0.0