UNPKG

clipanion/lib/advanced/options/Rest.d.ts

Version:

488 BTypeScriptView Raw

1export type RestFlags = {
  name?: string;
  required?: number;
4};
5/**
* Used to annotate that the command supports any number of positional
* arguments.
*
* Be careful: this function is order-dependent! Make sure to define it
* after any positional argument you want to declare.
*
* This function is mutually exclusive with Option.Proxy.
*
* @example
* yarn add hello world
*     ► rest = ["hello", "world"]
*/
18export declare function Rest(opts?: RestFlags): string[];

1	`export type RestFlags = {`
2	`name?: string;`
3	`required?: number;`
4	`};`
5	`/**`
6	`* Used to annotate that the command supports any number of positional`
7	`* arguments.`
8	`*`
9	`* Be careful: this function is order-dependent! Make sure to define it`
10	`* after any positional argument you want to declare.`
11	`*`
12	`* This function is mutually exclusive with Option.Proxy.`
13	`*`
14	`* @example`
15	`* yarn add hello world`
16	`* ► rest = ["hello", "world"]`
17	`*/`
18	`export declare function Rest(opts?: RestFlags): string[];`