mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-28 16:45:10 +08:00
37 lines
1016 B
TypeScript
37 lines
1016 B
TypeScript
// Type definitions for ora v0.3.0
|
|
// Project: https://github.com/sindresorhus/ora
|
|
// Definitions by: Basarat Ali Syed <https://github.com/basarat/>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
|
|
|
|
type Color = 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray';
|
|
type Text = string;
|
|
interface Options {
|
|
text?: Text;
|
|
spinner?: string | Spinner;
|
|
color?: Color;
|
|
interval?: number;
|
|
stream?: NodeJS.WritableStream;
|
|
enabled?: boolean;
|
|
}
|
|
interface Spinner {
|
|
interval?: number;
|
|
frames: string[];
|
|
}
|
|
interface Instance {
|
|
start(): Instance;
|
|
stop(): Instance;
|
|
succeed(): Instance;
|
|
fail(): Instance;
|
|
stopAndPersist(symbol?: string): Instance;
|
|
clear(): Instance;
|
|
render(): Instance;
|
|
frame(): Instance;
|
|
text: string;
|
|
color: Color;
|
|
}
|
|
declare function ora(options: Options | Text): Instance;
|
|
export = ora;
|