rdme
Version:
ReadMe's official CLI and GitHub Action.
44 lines (43 loc) • 1.41 kB
TypeScript
/**
* Wrapper for debug statements.
*/
declare function debug(input: unknown): void;
/**
* Wrapper for error statements.
*/
declare function error(input: string): void;
/**
* Wrapper for info/notice statements.
*
* @deprecated use the base command's `this.info` method instead.
*/
declare function info(input: string, opts?: {
/** whether or not to prefix the statement with this emoji: ℹ️ */
includeEmojiPrefix: boolean;
}): void;
declare function oraOptions(): {
text?: string | undefined;
prefixText?: (string | import("ora").PrefixTextGenerator) | undefined;
suffixText?: (string | import("ora").SuffixTextGenerator) | undefined;
spinner?: (import("cli-spinners").SpinnerName | import("ora").Spinner) | undefined;
color?: (import("ora").Color | boolean) | undefined;
hideCursor?: boolean | undefined;
indent?: number | undefined;
interval?: number | undefined;
stream?: NodeJS.WritableStream | undefined;
isEnabled?: boolean | undefined;
isSilent?: boolean | undefined;
discardStdin?: boolean | undefined;
};
/**
* Wrapper for warn statements.
*
* @deprecated use the base command's `this.warn` method instead.
*/
declare function warn(
/**
* Text that precedes the warning.
* This is *not* used in the GitHub Actions-formatted warning.
*/
input: string, prefix?: string): void;
export { debug, error, info, oraOptions, warn };