mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-09-22 21:30:44 +02:00
chore: update documentation
This commit is contained in:
@@ -11,6 +11,8 @@
|
||||
import { invoke } from '@tauri-apps/api/core'
|
||||
|
||||
/**
|
||||
* The resolution of a single CLI argument match.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
interface ArgMatch {
|
||||
@@ -27,18 +29,26 @@ interface ArgMatch {
|
||||
}
|
||||
|
||||
/**
|
||||
* The result of matching a subcommand of the CLI definition.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
interface SubcommandMatch {
|
||||
/** The name of the matched subcommand. */
|
||||
name: string
|
||||
/** The argument matches of the subcommand, resolved the same way as the parent command's matches. */
|
||||
matches: CliMatches
|
||||
}
|
||||
|
||||
/**
|
||||
* The resolved matches of the CLI arguments and, if any, its matched subcommand.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
interface CliMatches {
|
||||
/** The matched arguments, keyed by argument name. */
|
||||
args: Record<string, ArgMatch>
|
||||
/** The matched subcommand, or `null` if no subcommand was invoked. */
|
||||
subcommand: SubcommandMatch | null
|
||||
}
|
||||
|
||||
@@ -61,6 +71,7 @@ interface CliMatches {
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @returns A promise resolving to the parsed CLI matches.
|
||||
* @since 2.0.0
|
||||
*/
|
||||
async function getMatches(): Promise<CliMatches> {
|
||||
|
||||
Reference in New Issue
Block a user