mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-05-31 13:39:36 +02:00
Fynn Tang
40ef9a818f
* Update package versions and modify OS plugin The version numbers for multiple packages have been updated in Cargo.lock. Additionally, changes were made in the OS plugin, specifically in the `index.ts` file where asynchronous function calls have been transformed into synchronous ones. * Update package versions in Cargo.lock Several packages in Cargo.lock have been updated to new versions. This includes "hyper", "hyper-util", "open", "serde_json", and "zerocopy" packages. Each package has had its version, checksum, and associated dependencies adjusted to reflect the latest release. * Update OS sync functions in documentation examples The documentation examples for `platform`, `arch`, `type`, `family`, `version`, and `exe_extension` functions have been updated. The changes are intended to better illustrate that these functions are synchronous.
197 lines
4.2 KiB
TypeScript
197 lines
4.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.
|
||
*
|
||
* @module
|
||
*/
|
||
|
||
import { invoke } from "@tauri-apps/api/core";
|
||
|
||
/** @ignore */
|
||
declare global {
|
||
interface Window {
|
||
__TAURI_OS_PLUGIN_INTERNALS__: {
|
||
eol: string;
|
||
os_type: OsType;
|
||
platform: Platform;
|
||
family: Family;
|
||
version: string;
|
||
arch: Arch;
|
||
exe_extension: string;
|
||
};
|
||
}
|
||
}
|
||
|
||
type Platform =
|
||
| "linux"
|
||
| "macos"
|
||
| "ios"
|
||
| "freebsd"
|
||
| "dragonfly"
|
||
| "netbsd"
|
||
| "openbsd"
|
||
| "solaris"
|
||
| "android"
|
||
| "windows";
|
||
|
||
type OsType = "linux" | "windows" | "macos" | "ios" | "android";
|
||
|
||
type Arch =
|
||
| "x86"
|
||
| "x86_64"
|
||
| "arm"
|
||
| "aarch64"
|
||
| "mips"
|
||
| "mips64"
|
||
| "powerpc"
|
||
| "powerpc64"
|
||
| "riscv64"
|
||
| "s390x"
|
||
| "sparc64";
|
||
|
||
/**
|
||
* Returns the operating system-specific end-of-line marker.
|
||
* - `\n` on POSIX
|
||
* - `\r\n` on Windows
|
||
*
|
||
* @since 2.0.0
|
||
* */
|
||
function eol(): string {
|
||
return window.__TAURI_OS_PLUGIN_INTERNALS__.eol;
|
||
}
|
||
|
||
/**
|
||
* 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
|
||
* ```typescript
|
||
* import { platform } from '@tauri-apps/plugin-os';
|
||
* const platformName = platform();
|
||
* ```
|
||
*
|
||
* @since 2.0.0
|
||
*
|
||
*/
|
||
function platform(): Platform {
|
||
return window.__TAURI_OS_PLUGIN_INTERNALS__.platform;
|
||
}
|
||
|
||
/**
|
||
* Returns the current operating system version.
|
||
* @example
|
||
* ```typescript
|
||
* import { version } from '@tauri-apps/plugin-os';
|
||
* const osVersion = version();
|
||
* ```
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
function version(): string {
|
||
return window.__TAURI_OS_PLUGIN_INTERNALS__.version;
|
||
}
|
||
|
||
type Family = "unix" | "windows";
|
||
|
||
/**
|
||
* Returns the current operating system family. Possible values are `'unix'`, `'windows'`.
|
||
* @example
|
||
* ```typescript
|
||
* import { family } from '@tauri-apps/plugin-os';
|
||
* const family = family();
|
||
* ```
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
function family(): Family {
|
||
return window.__TAURI_OS_PLUGIN_INTERNALS__.family;
|
||
}
|
||
|
||
/**
|
||
* Returns the current operating system type. Returns `'linux'` on Linux, `'macos'` on macOS, `'windows'` on Windows, `'ios'` on iOS and `'android'` on Android.
|
||
* @example
|
||
* ```typescript
|
||
* import { type } from '@tauri-apps/plugin-os';
|
||
* const osType = type();
|
||
* ```
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
function type(): OsType {
|
||
return window.__TAURI_OS_PLUGIN_INTERNALS__.os_type;
|
||
}
|
||
|
||
/**
|
||
* Returns the current operating system architecture.
|
||
* 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 = arch();
|
||
* ```
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
function arch(): Arch {
|
||
return window.__TAURI_OS_PLUGIN_INTERNALS__.arch;
|
||
}
|
||
|
||
/**
|
||
* Returns the file extension, if any, used for executable binaries on this platform. Possible values are `'exe'` and `''` (empty string).
|
||
* @example
|
||
* ```typescript
|
||
* import { exeExtension } from '@tauri-apps/plugin-os';
|
||
* const exeExt = exeExtension();
|
||
* ```
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
function exeExtension(): string {
|
||
return window.__TAURI_OS_PLUGIN_INTERNALS__.exe_extension;
|
||
}
|
||
|
||
/**
|
||
* Returns a String with a `BCP-47` language tag inside. If the locale couldn’t be obtained, `null` is returned instead.
|
||
* @example
|
||
* ```typescript
|
||
* import { locale } from '@tauri-apps/plugin-os';
|
||
* const locale = await locale();
|
||
* if (locale) {
|
||
* // use the locale string here
|
||
* }
|
||
* ```
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
async function locale(): Promise<string | null> {
|
||
return await invoke("plugin:os|locale");
|
||
}
|
||
|
||
/**
|
||
* Returns the host name of the operating system.
|
||
* @example
|
||
* ```typescript
|
||
* import { hostname } from '@tauri-apps/plugin-os';
|
||
* const hostname = await hostname();
|
||
* ```
|
||
*/
|
||
async function hostname(): Promise<string | null> {
|
||
return await invoke("plugin:os|hostname");
|
||
}
|
||
|
||
export {
|
||
eol,
|
||
platform,
|
||
family,
|
||
version,
|
||
type,
|
||
arch,
|
||
locale,
|
||
exeExtension,
|
||
hostname,
|
||
};
|
||
export type { Platform, OsType, Arch, Family };
|