| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,11 +7,47 @@ export type Loggable = string | string[]; | |||
| 7 | 7 | export type LoggableError = Loggable | Error; | |
| 8 | 8 | ||
| 9 | 9 | export interface Logger { | |
| 10 | + /** | ||
| 11 | + * Logs {@link message} at debug-level. | ||
| 12 | + * In Actions, this will only be output if workflow debugging is enabled. | ||
| 13 | + * | ||
| 14 | + * @param message | ||
| 15 | + * A string or an array of strings. If an array of strings is provided, they are joined using | ||
| 16 | + * space as the delimiter and printed as a single line. | ||
| 17 | + */ | ||
| 10 | 18 | debug: (message: Loggable) => void; | |
| 19 | + /** | ||
| 20 | + * Logs {@link message} at info-level. | ||
| 21 | + * In Actions, this will always be output. | ||
| 22 | + * | ||
| 23 | + * @param message | ||
| 24 | + * A string or an array of strings. If an array of strings is provided, they are joined using | ||
| 25 | + * space as the delimiter and printed as a single line. | ||
| 26 | + */ | ||
| 11 | 27 | info: (message: Loggable) => void; | |
| 28 | + /** | ||
| 29 | + * Logs {@link message} at warning-level. | ||
| 30 | + * In Actions, this will always be output and highlighted as a warning. It will additionally | ||
| 31 | + * result in a warning-level workflow annotation. | ||
| 32 | + * | ||
| 33 | + * @param message | ||
| 34 | + * A string or an array of strings. If an array of strings is provided, they are joined using | ||
| 35 | + * space as the delimiter and printed as a single line. | ||
| 36 | + */ | ||
| 12 | 37 | warning: (message: LoggableError) => void; | |
| 38 | + /** | ||
| 39 | + * Logs {@link message} at error-level. | ||
| 40 | + * In Actions, this will always be output and highlighted as an error. It will additionally | ||
| 41 | + * result in an error-level workflow annotation. | ||
| 42 | + * | ||
| 43 | + * @param message | ||
| 44 | + * A string or an array of strings. If an array of strings is provided, they are joined using | ||
| 45 | + * space as the delimiter and printed as a single line. | ||
| 46 | + */ | ||
| 13 | 47 | error: (message: LoggableError) => void; | |
| 14 | - | ||
| 48 | + /** | ||
| 49 | + * Gets a value indicating whether debugging is enabled. | ||
| 50 | + */ | ||
| 15 | 51 | isDebug: () => boolean; | |
| 16 | 52 | ||
| 17 | 53 | startGroup: (name: string) => void; | |
| Back | FazBrowse Home | New Git URL |
0 commit comments