Fixed type definitions for ora v0.3.0

This commit is contained in:
Christian Rackerseder
2016-10-17 18:00:33 +02:00
parent da2ec68366
commit 36b5f7e573
2 changed files with 22 additions and 14 deletions

View File

@@ -1,10 +1,7 @@
/// <reference path="ora.d.ts" />
import ora = require('ora');
const spinner = ora('Loading unicorns');
spinner.start();
const spinner = ora('Loading unicorns').start();
setTimeout(() => {
spinner.color = 'yellow';
spinner.text = 'Loading rainbows';

31
ora/ora.d.ts vendored
View File

@@ -1,24 +1,35 @@
// Type definitions for ora
// 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
declare module 'ora' {
/// <reference path="../node/node.d.ts" />
declare module "ora" {
type Color = 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray';
type Text = string;
interface Options {
text?: Text;
spinner?: string | { interval?: number; frames: string[]; }
spinner?: string | Spinner;
color?: Color;
stream?: any;
interval?: number;
stream?: NodeJS.WritableStream;
enabled?: boolean;
}
interface Spinner {
interval?: number;
frames: string[];
}
interface Instance {
start(): void;
stop(): void;
clear(): void;
frame(): void;
render(): void;
text: Text;
start(): Instance;
stop(): Instance;
succeed(): Instance;
fail(): Instance;
stopAndPersist(symbol?: string): Instance;
clear(): Instance;
render(): Instance;
frame(): Instance;
text: string;
color: Color;
}
function ora(options: Options | Text): Instance;