跳至主要内容

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[]

如果采用值，则为字符串；如果采用标志，则为布尔值；如果采用多个值，则为字符串数组或 null

定义于： 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

属性​

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>