cli

解析命令行界面的参数。

当 tauri.conf.json 中的 build.withGlobalTauri 设置为 true 时，也可以通过 window.__TAURI__.cli 访问此软件包。

接口

ArgMatch

自1.0.0版本起

属性

occurrences

occurrences: number

出现次数

定义在: cli.ts:27

value

value: null | string | boolean | string[]

字符串（如果取值） 布尔值（如果标志字符串[]） 或空（如果取多个值

Defined in: cli.ts:23

CliMatches

自1.0.0版本起

属性

args

args: Record<string, ArgMatch>

定义在: cli.ts:42

subcommand

subcommand: null | SubcommandMatch

定义在: cli.ts:43

SubcommandMatch

自1.0.0版本起

Properties

matches

matches: CliMatches

定义在: cli.ts:35

name

name: string

定义在: cli.ts:34

方法

getMatches

getMatches(): Promise<CliMatches>

解析提供给当前进程的参数，并使用 tauri.conf.json 中定义的 tauri.cli 配置获取匹配参数

示例

import { getMatches } from '@tauri-apps/api/cli';
const matches = await getMatches();
if (matches.subcommand?.name === 'run') {
  // `./your-app run $ARGS` was executed
  const args = matches.subcommand?.matches.args
  if ('debug' in args) {
    // `./your-app run --debug` was executed
  }
} else {
  const args = matches.args
  // `./your-app $ARGS` was executed
}

自1.0.0版本起

返回值: Promise<CliMatches>