|
2 | 2 | * Describes the action interface.
|
3 | 3 | */
|
4 | 4 | export interface ActionInterface {
|
5 |
| - /** Deployment token. */ |
| 5 | + /** |
| 6 | + * Deployment token. |
| 7 | + */ |
6 | 8 | token?: string;
|
7 |
| - /** The template to use. */ |
| 9 | + /** |
| 10 | + * The template to use. |
| 11 | + */ |
8 | 12 | template: string;
|
9 |
| - /** The file to replace the content in. */ |
| 13 | + /** |
| 14 | + * The file to replace the content in. |
| 15 | + */ |
10 | 16 | file: string;
|
11 |
| - /** The minimum amount sponsored to be included. */ |
| 17 | + /** |
| 18 | + * The minimum amount sponsored to be included. |
| 19 | + */ |
12 | 20 | minimum: number;
|
13 |
| - /** The maximum amount sponsored to be included. */ |
| 21 | + /** |
| 22 | + * The maximum amount sponsored to be included. |
| 23 | + */ |
14 | 24 | maximum: number;
|
15 |
| - /** The marker at which the content should be included within. */ |
| 25 | + /** |
| 26 | + * The marker at which the content should be included within. |
| 27 | + */ |
16 | 28 | marker: string;
|
17 |
| - /** If the user has no sponsors, we can replace it with a fallback. */ |
| 29 | + /** |
| 30 | + * If the user has no sponsors, we can replace it with a fallback. |
| 31 | + */ |
18 | 32 | fallback: string;
|
19 |
| - /** Fetches organization level sponsors if true. */ |
| 33 | + /** |
| 34 | + * Fetches organization level sponsors if true. |
| 35 | + */ |
20 | 36 | organization: boolean;
|
21 |
| - /** Determines if inactive sponsors should be returned or not. */ |
| 37 | + /** |
| 38 | + * Determines if inactive sponsors should be returned or not. |
| 39 | + */ |
22 | 40 | activeOnly: boolean;
|
23 |
| - /** Determines if private sponsors should be returned or not. If marked as true, the identity of the sponsor is still |
24 |
| - kept private, however, an anonymized version of the sponsor is still included in the list. */ |
| 41 | + /** |
| 42 | + * Determines if private sponsors should be returned or not. If marked as true, the identity of the sponsor is still |
| 43 | + * kept private, however, an anonymized version of the sponsor is still included in the list. |
| 44 | + */ |
25 | 45 | includePrivate: boolean;
|
26 | 46 | }
|
27 | 47 | /**
|
|
0 commit comments