From acc3fd00ce9019de20a110ed0b24738a484331aa Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Wed, 12 Dec 2018 09:05:06 +0100 Subject: [PATCH] Add types for chalk-animation --- .../chalk-animation/chalk-animation-tests.ts | 21 +++++++++++++++++ types/chalk-animation/index.d.ts | 21 +++++++++++++++++ types/chalk-animation/tsconfig.json | 23 +++++++++++++++++++ types/chalk-animation/tslint.json | 1 + 4 files changed, 66 insertions(+) create mode 100644 types/chalk-animation/chalk-animation-tests.ts create mode 100644 types/chalk-animation/index.d.ts create mode 100644 types/chalk-animation/tsconfig.json create mode 100644 types/chalk-animation/tslint.json diff --git a/types/chalk-animation/chalk-animation-tests.ts b/types/chalk-animation/chalk-animation-tests.ts new file mode 100644 index 0000000000..e2f12e58b3 --- /dev/null +++ b/types/chalk-animation/chalk-animation-tests.ts @@ -0,0 +1,21 @@ +import * as chalkAnimation from 'chalk-animation'; + +const rainbow: chalkAnimation.Animation = chalkAnimation.rainbow('Lorem ipsum dolor sit amet'); +chalkAnimation.rainbow('Lorem ipsum dolor sit amet', 2); +chalkAnimation.pulse('Lorem ipsum dolor sit amet'); +chalkAnimation.pulse('Lorem ipsum dolor sit amet', 2); +chalkAnimation.glitch('Lorem ipsum dolor sit amet'); +chalkAnimation.glitch('Lorem ipsum dolor sit amet', 2); +chalkAnimation.radar('Lorem ipsum dolor sit amet'); +chalkAnimation.radar('Lorem ipsum dolor sit amet', 2); +chalkAnimation.neon('Lorem ipsum dolor sit amet'); +chalkAnimation.neon('Lorem ipsum dolor sit amet', 2); +chalkAnimation.karaoke('Lorem ipsum dolor sit amet'); +chalkAnimation.karaoke('Lorem ipsum dolor sit amet', 2); + +rainbow.stop(); +rainbow.start(); +rainbow.replace('.'); +rainbow.render(); +// $ExpectType string +rainbow.frame(); diff --git a/types/chalk-animation/index.d.ts b/types/chalk-animation/index.d.ts new file mode 100644 index 0000000000..9f08617bb3 --- /dev/null +++ b/types/chalk-animation/index.d.ts @@ -0,0 +1,21 @@ +// Type definitions for chalk-animation 1.6 +// Project: https://github.com/bokub/chalk-animation +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export const rainbow: AnimationFn; +export const pulse: AnimationFn; +export const glitch: AnimationFn; +export const radar: AnimationFn; +export const neon: AnimationFn; +export const karaoke: AnimationFn; + +export type AnimationFn = (text: string, speed?: number) => Animation; + +export interface Animation { + start(): void; + stop(): void; + replace(text: string): void; + render(): void; + frame(): string; +} diff --git a/types/chalk-animation/tsconfig.json b/types/chalk-animation/tsconfig.json new file mode 100644 index 0000000000..bf580a6e70 --- /dev/null +++ b/types/chalk-animation/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "chalk-animation-tests.ts" + ] +} diff --git a/types/chalk-animation/tslint.json b/types/chalk-animation/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/chalk-animation/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }