@tauri-apps/plugin-cli

从命令行界面解析参数。

接口

ArgMatch

始于

2.0.0

属性

属性	类型	描述	定义于
occurrences	数字	出现次数	来源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L26
value	null | string | boolean | string[]	如果接收值，则为字符串；如果为标志，则为布尔值；如果接收多个值，则为字符串数组或 null。	来源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L22

---

CliMatches

始于

2.0.0

属性

属性	类型	定义于
args	Record<string, ArgMatch>	来源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L41
subcommand	null | SubcommandMatch	来源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L42

---

SubcommandMatch

始于

2.0.0

属性

属性	类型	定义于
matches	CliMatches	来源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L34
name	string	来源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L33

函数

getMatches()

function getMatches(): Promise<CliMatches>

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

返回

Promise<CliMatches>

示例

import { getMatches } from '@tauri-apps/plugin-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
}

始于

2.0.0

来源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L66