跳到主要内容

cli

解析来自命令行界面的参数。

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

接口​

ArgMatch​

自: 1.0.0

属性​

occurrences​

occurrences: number

出现次数

定义于： cli.ts:27

value​

value: null| 字符串 | 布尔值 | 字符串[]

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

定义于： cli.ts:23

CliMatches​

自: 1.0.0

属性​

args​

args: Record<string, ArgMatch>

定义于： cli.ts:42

subcommand​

subcommand: null| 子命令匹配

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