🏷️ feat(UIGF): 添加 Uigf 类型,调整 Uiaf 类型

This commit is contained in:
BTMuli
2023-04-19 15:07:55 +08:00
parent 80092c0a42
commit 77b40185df
3 changed files with 123 additions and 21 deletions

View File

@@ -1,18 +1,18 @@
/**
* @description 获取 UIAF 头部信息
* @since Alpha v0.1.2
* @returns {Promise<TGPlugin.UIAF.Header>}
* @file utils UIAF.ts
* @description UIAF工具类
* @author BTMuli<bt-muli@outlook.com>
* @since Alpha v0.1.3
*/
import { app, fs } from "@tauri-apps/api";
/**
* @description 获取 UIAF 头部信息
* @since Alpha v0.1.2
* @since Alpha v0.1.3
* @returns {Promise<TGPlugin.UIAF.Header>}
*/
export async function getHeader (): Promise<TGPlugin.UIAF.Header> {
export async function getUiafHeader (): Promise<TGPlugin.UIAF.Header> {
return {
// eslint-disable-next-line camelcase
export_app: "Tauri.Genshin",
@@ -28,23 +28,23 @@ export async function getHeader (): Promise<TGPlugin.UIAF.Header> {
/**
* @description 检测是否存在 UIAF 数据
* @description 粗略检测,不保证数据完整性
* @since Alpha v0.1.2
* @since Alpha v0.1.3
* @param {string} path - UIAF 数据路径
* @returns {Promise<boolean>} 是否存在 UIAF 数据
*/
export async function verifyUIAF (path: string): Promise<boolean> {
export async function verifyUiafData (path: string): Promise<boolean> {
const fileData: string = await fs.readTextFile(path);
const UIAFData: TGPlugin.UIAF.Header = JSON.parse(fileData).info;
return UIAFData.uiaf_version !== undefined;
const UiafData: TGPlugin.UIAF.Header = JSON.parse(fileData).info;
return UiafData.uiaf_version !== undefined;
}
/**
* @description 读取 UIAF 数据
* @since Alpha v0.1.2
* @since Alpha v0.1.3
* @param {string} userPath - UIAF 数据路径
* @returns {Promise<string|false>} UIAF 数据
*/
export async function readUIAF (userPath: string): Promise<string | false> {
export async function readUiafData (userPath: string): Promise<string | false> {
if (await fs.exists(userPath)) {
const fileData = await fs.readTextFile(userPath);
if (fileData !== undefined && fileData !== null && fileData !== "" && fileData !== "{}") {