@tauri-apps/plugin-cli

解析來自命令列介面的參數。

介面

ArgMatch

自

2.0.0

屬性

屬性	類型	描述	定義於
occurrences	number	出現次數	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L26
value	null | string | boolean | string[]	string (若接受值) boolean (若為旗標) string[] 或 null (若接受多個值)	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L22

---

CliMatches

自

2.0.0

屬性

屬性	類型	定義於
args	Record<string, ArgMatch>	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L41
subcommand	null | SubcommandMatch	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L42

---

SubcommandMatch

自

2.0.0

屬性

屬性	類型	定義於
matches	CliMatches	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L34
name	string	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/cli/guest-js/index.ts#L33

函式

getMatches()

function getMatches(): Promise<CliMatches>

解析提供給當前程序的參數，並使用 tauri.cli 中定義的組態，取得符合的項目 (matches) tauri.conf.json

回傳

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

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