archived-tauri-docs/docs/api/js/modules/os.md

@tauri-apps/api / os

Module: os

Provides operating system-related utility methods and properties.

This package is also accessible with window.__TAURI__.os when tauri.conf.json > build > withGlobalTauri is set to true.

The APIs must be allowlisted on tauri.conf.json:

{
  "tauri": {
    "allowlist": {
      "os": {
        "all": true, // enable all Os APIs
      }
    }
  }
}

It is recommended to allowlist only the APIs you use for optimal bundle size and security.

Variables

EOL

• Const EOL: "\r\n" | "\n"

The operating system-specific end-of-line marker.

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

Defined in

os.ts:35

Functions

arch

▸ arch(): Promise<LiteralUnion<"x86" | "x86_64" | "arm" | "aarch64" | "mips" | "mips64" | "powerpc" | "powerpc64" | "riscv64" | "s390x" | "sparc64", string>>

Returns the operating system CPU architecture for which the tauri app was compiled. Possible values are 'x86', 'x86_64', 'arm', 'aarch64', 'mips', 'mips64', 'powerpc', 'powerpc64', 'riscv64', 's390x', 'sparc64'

Returns

Promise<LiteralUnion<"x86" | "x86_64" | "arm" | "aarch64" | "mips" | "mips64" | "powerpc" | "powerpc64" | "riscv64" | "s390x" | "sparc64", string>>

Defined in

os.ts:93

---

platform

▸ platform(): Promise<LiteralUnion<"linux" | "darwin" | "ios" | "freebsd" | "dragonfly" | "netbsd" | "openbsd" | "solaris" | "android" | "win32", string>>

Returns a string identifying the operating system platform. The value is set at compile time. Possible values are 'linux', 'darwin', 'ios', 'freebsd', 'dragonfly', 'netbsd', 'openbsd', 'solaris', 'android', 'win32'

Returns

Promise<LiteralUnion<"linux" | "darwin" | "ios" | "freebsd" | "dragonfly" | "netbsd" | "openbsd" | "solaris" | "android" | "win32", string>>

Defined in

os.ts:41

---

tempdir

▸ tempdir(): Promise<string>

Returns the operating system's default directory for temporary files as a string.

Returns

Promise<string>

Defined in

os.ts:120

---

type

▸ type(): Promise<LiteralUnion<"Linux" | "Darwin" | "Windows_NT", string>>

Returns 'Linux' on Linux, 'Darwin' on macOS, and 'Windows_NT' on Windows.

Returns

Promise<LiteralUnion<"Linux" | "Darwin" | "Windows_NT", string>>

Defined in

os.ts:79

---

version

▸ version(): Promise<string>

Returns a string identifying the kernel version.

Returns

Promise<string>

Defined in

os.ts:67