mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-06-06 13:53:54 +02:00
Lucas Fernandes Nogueira
141 lines
3.2 KiB
TypeScript
141 lines
3.2 KiB
TypeScript
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
/**
|
|
* Provides operating system-related utility methods and properties.
|
|
*
|
|
* The APIs must be added to [`tauri.allowlist.os`](https://tauri.app/v1/api/config/#allowlistconfig.os) in `tauri.conf.json`:
|
|
* ```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.
|
|
* @module
|
|
*/
|
|
|
|
import { invoke } from "@tauri-apps/api/tauri";
|
|
|
|
type Platform =
|
|
| "linux"
|
|
| "darwin"
|
|
| "ios"
|
|
| "freebsd"
|
|
| "dragonfly"
|
|
| "netbsd"
|
|
| "openbsd"
|
|
| "solaris"
|
|
| "android"
|
|
| "win32";
|
|
|
|
type OsType = "Linux" | "Darwin" | "Windows_NT";
|
|
|
|
type Arch =
|
|
| "x86"
|
|
| "x86_64"
|
|
| "arm"
|
|
| "aarch64"
|
|
| "mips"
|
|
| "mips64"
|
|
| "powerpc"
|
|
| "powerpc64"
|
|
| "riscv64"
|
|
| "s390x"
|
|
| "sparc64";
|
|
|
|
function isWindows(): boolean {
|
|
return navigator.appVersion.includes("Win");
|
|
}
|
|
|
|
/**
|
|
* The operating system-specific end-of-line marker.
|
|
* - `\n` on POSIX
|
|
* - `\r\n` on Windows
|
|
*
|
|
* @since 1.0.0
|
|
* */
|
|
const EOL = isWindows() ? "\r\n" : "\n";
|
|
|
|
/**
|
|
* 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'`
|
|
* @example
|
|
* ```typescript
|
|
* import { platform } from '@tauri-apps/plugin-os';
|
|
* const platformName = await platform();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
*/
|
|
async function platform(): Promise<Platform> {
|
|
return invoke("plugin:os|platform");
|
|
}
|
|
|
|
/**
|
|
* Returns a string identifying the kernel version.
|
|
* @example
|
|
* ```typescript
|
|
* import { version } from '@tauri-apps/plugin-os';
|
|
* const osVersion = await version();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
async function version(): Promise<string> {
|
|
return invoke("plugin:os|version");
|
|
}
|
|
|
|
/**
|
|
* Returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows.
|
|
* @example
|
|
* ```typescript
|
|
* import { type } from '@tauri-apps/plugin-os';
|
|
* const osType = await type();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
async function type(): Promise<OsType> {
|
|
return invoke("plugin:os|kind");
|
|
}
|
|
|
|
/**
|
|
* 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'`.
|
|
* @example
|
|
* ```typescript
|
|
* import { arch } from '@tauri-apps/plugin-os';
|
|
* const archName = await arch();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
async function arch(): Promise<Arch> {
|
|
return invoke("plugin:os|arch");
|
|
}
|
|
|
|
/**
|
|
* Returns the operating system's default directory for temporary files as a string.
|
|
* @example
|
|
* ```typescript
|
|
* import { tempdir } from '@tauri-apps/plugin-os';
|
|
* const tempdirPath = await tempdir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
async function tempdir(): Promise<string> {
|
|
return invoke("plugin:os|tempdir");
|
|
}
|
|
|
|
export { EOL, platform, version, type, arch, tempdir };
|
|
export type { Platform, OsType, Arch };
|