From d4b884967ee667942d570a68c55d3b6fd8c9a047 Mon Sep 17 00:00:00 2001 From: Denis Malinochkin Date: Thu, 24 May 2018 19:40:07 +0300 Subject: [PATCH] feat(types): Add typings for "run-parallel-limit" package --- types/run-parallel-limit/index.d.ts | 21 ++++++++ .../run-parallel-limit-tests.ts | 52 +++++++++++++++++++ types/run-parallel-limit/tsconfig.json | 23 ++++++++ types/run-parallel-limit/tslint.json | 1 + 4 files changed, 97 insertions(+) create mode 100644 types/run-parallel-limit/index.d.ts create mode 100644 types/run-parallel-limit/run-parallel-limit-tests.ts create mode 100644 types/run-parallel-limit/tsconfig.json create mode 100644 types/run-parallel-limit/tslint.json diff --git a/types/run-parallel-limit/index.d.ts b/types/run-parallel-limit/index.d.ts new file mode 100644 index 0000000000..90bd61f2c5 --- /dev/null +++ b/types/run-parallel-limit/index.d.ts @@ -0,0 +1,21 @@ +// Type definitions for run-parallel-limit 1.0 +// Project: https://github.com/feross/run-parallel-limit +// Definitions by: mrmlnc +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.1 + +declare namespace RunParallelLimit { + type TaskCallback = (err: Error | null, results?: T) => void; + type Task = (callback: TaskCallback) => void; + type TaskObj = Record>; + + type Callback = (err: Error, results: T) => void; +} + +declare function RunParallelLimit(tasks: Array>, limit: number): T[]; +declare function RunParallelLimit(tasks: Array>, limit: number, callback: RunParallelLimit.Callback): void; + +declare function RunParallelLimit(tasks: RunParallelLimit.TaskObj, limit: number): Record; +declare function RunParallelLimit(tasks: RunParallelLimit.TaskObj, limit: number, callback: RunParallelLimit.Callback>): void; + +export = RunParallelLimit; diff --git a/types/run-parallel-limit/run-parallel-limit-tests.ts b/types/run-parallel-limit/run-parallel-limit-tests.ts new file mode 100644 index 0000000000..3a4c209fcc --- /dev/null +++ b/types/run-parallel-limit/run-parallel-limit-tests.ts @@ -0,0 +1,52 @@ +import rpl = require('run-parallel-limit'); + +const tasks: Array> = [ + (callback) => () => callback(null, 'string'), + (callback) => () => callback(new Error('boom')), + + // $ExpectError + (callback) => () => callback(null, 1) +]; + +const justTaskCallback: rpl.TaskCallback = (err, result) => { + // $ExpectType Error | null + err; + + // $ExpectType string | undefined + result; +}; + +justTaskCallback(null, 'string'); +justTaskCallback(new Error('boom')); +// $ExpectError +justTaskCallback(null, 1); + +rpl(tasks, 5, (err, results) => { + // $ExpectType Error + err; + + // $ExpectType string[] + results; +}); + +// $ExpectType string[] +const results = rpl(tasks, 5); + +const tasksObj: rpl.TaskObj = { + one: (callback) => () => callback(null, 'string'), + two: (callback) => () => callback(new Error('boom')), + + // $ExpectError + three: (callback) => () => callback(1) +}; + +rpl(tasksObj, 5, (err, results) => { + // $ExpectType Error + err; + + // $ExpectType Record + results; +}); + +// $ExpectType Record +const resultsObj = rpl(tasksObj, 5); diff --git a/types/run-parallel-limit/tsconfig.json b/types/run-parallel-limit/tsconfig.json new file mode 100644 index 0000000000..bc8072befe --- /dev/null +++ b/types/run-parallel-limit/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", + "run-parallel-limit-tests.ts" + ] +} diff --git a/types/run-parallel-limit/tslint.json b/types/run-parallel-limit/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/run-parallel-limit/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }