@tauri-apps/plugin-os

Provides operating system-related utility methods and properties.

Functions

arch()

function arch(): Arch;

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

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

Example

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

Returns

Arch

The operating system architecture.

Since

2.0.0

---

eol()

function eol(): string;

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

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

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

Example

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

Returns

string

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

Since

2.0.0

---

exeExtension()

function exeExtension(): string;

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

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

Example

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

Returns

string

The file extension used for executable binaries on this platform.

Since

2.0.0

---

family()

function family(): Family;

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

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

Example

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

Returns

Family

The operating system family.

Since

2.0.0

---

hostname()

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

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

Returns the host name of the operating system.

Example

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

Returns

Promise<string | null>

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

Since

2.0.0

---

locale()

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

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

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

Example

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

Returns

Promise<string | null>

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

Since

2.0.0

---

platform()

function platform(): Platform;

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

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'

Example

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

Returns

Platform

The platform name.

Since

2.0.0

---

type()

function type(): OsType;

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

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

Example

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

Returns

OsType

The operating system type.

Since

2.0.0

---

version()

function version(): string;

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

Returns the current operating system version.

Example

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

Returns

string

The operating system version.

Since

2.0.0

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:51

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

---

Family

type Family = "unix" | "windows";

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

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

---

OsType

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

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

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

---

Platform

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

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

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