From acdb7b6f5e633e8b361fdc4cac94d904d19c7e2e Mon Sep 17 00:00:00 2001 From: Dmitry Radkovskiy Date: Wed, 31 Aug 2016 17:07:42 +0300 Subject: [PATCH 1/6] node-dir: added types for callback params --- node-dir/node-dir.d.ts | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/node-dir/node-dir.d.ts b/node-dir/node-dir.d.ts index 857cdf7bdf..9f45441d4f 100644 --- a/node-dir/node-dir.d.ts +++ b/node-dir/node-dir.d.ts @@ -37,11 +37,11 @@ declare module "node-dir" { } export interface FileCallback { - (error: any, content: any, next: () => void): void; + (error: any, content: string, next: () => void): void; } export interface FileNamedCallback { - (error: any, content: any, filename: string, next: () => void): void; + (error: any, content: string, filename: string, next: () => void): void; } export interface StreamCallback { @@ -49,7 +49,11 @@ declare module "node-dir" { } export interface FinishedCallback { - (error: any, files: any): void; + (error: any, files: string[]): void; + } + export interface PathsResult { + files: string[]; + dirs: string[]; } export function readFiles(dir: string, fileCallback: FileCallback, finishedCallback?: FinishedCallback): void; @@ -58,8 +62,9 @@ declare module "node-dir" { export function readFiles(dir: string, options: Options, fileCallback: FileNamedCallback, finishedCallback?: FinishedCallback): void; export function readFilesStream(dir: string, options: Options, streamCallback: StreamCallback, finishedCallback?: FinishedCallback): void; - export function files(dir: string, callback: (error: any, files: any) => void): void; - export function subdirs(dir: string, callback: (error: any, subdirs: any) => void): void; - export function paths(dir: string, callback: (error: any, paths: any) => void): void; - export function paths(dir: string, combine: boolean, callback: (error: any, paths: any) => void): void; + export function files(dir: string, callback: (error: any, files: string[]) => void): void; + export function subdirs(dir: string, callback: (error: any, subdirs: string[]) => void): void; + export function paths(dir: string, callback: (error: any, paths: PathsResult) => void): void; + export function paths(dir: string, combine: true, callback: (error: any, paths: string[]) => void): void; + export function paths(dir: string, combine: false, callback: (error: any, paths: PathsResult) => void): void; } From 9fbbb355351e32e7727ca35b885b62f3af50ec57 Mon Sep 17 00:00:00 2001 From: Dmitry Radkovskiy Date: Fri, 2 Sep 2016 14:31:14 +0300 Subject: [PATCH 2/6] Buffer and ReadStream types --- node-dir/node-dir.d.ts | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/node-dir/node-dir.d.ts b/node-dir/node-dir.d.ts index 9f45441d4f..4ffaf0e093 100644 --- a/node-dir/node-dir.d.ts +++ b/node-dir/node-dir.d.ts @@ -4,6 +4,8 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare module "node-dir" { + import { ReadStream } from "fs"; + export interface Options { // file encoding (defaults to 'utf8') encoding?: string; @@ -37,31 +39,28 @@ declare module "node-dir" { } export interface FileCallback { - (error: any, content: string, next: () => void): void; + (error: any, content: string | Buffer, next: () => void): void; } export interface FileNamedCallback { - (error: any, content: string, filename: string, next: () => void): void; + (error: any, content: string | Buffer, filename: string, next: () => void): void; } export interface StreamCallback { - (error: any, stream: any, next: () => void): void; + (error: any, stream: ReadStream, next: () => void): void; } export interface FinishedCallback { (error: any, files: string[]): void; } export interface PathsResult { - files: string[]; - dirs: string[]; + files: string[]; + dirs: string[]; } - export function readFiles(dir: string, fileCallback: FileCallback, finishedCallback?: FinishedCallback): void; - export function readFiles(dir: string, fileCallback: FileNamedCallback, finishedCallback?: FinishedCallback): void; - export function readFiles(dir: string, options: Options, fileCallback: FileCallback, finishedCallback?: FinishedCallback): void; - export function readFiles(dir: string, options: Options, fileCallback: FileNamedCallback, finishedCallback?: FinishedCallback): void; - export function readFilesStream(dir: string, options: Options, streamCallback: StreamCallback, - finishedCallback?: FinishedCallback): void; + export function readFiles(dir: string, fileCallback: FileCallback | FileNamedCallback, finishedCallback?: FinishedCallback): void; + export function readFiles(dir: string, options: Options, fileCallback: FileCallback | FileNamedCallback, finishedCallback?: FinishedCallback): void; + export function readFilesStream(dir: string, options: Options, streamCallback: StreamCallback, finishedCallback?: FinishedCallback): void; export function files(dir: string, callback: (error: any, files: string[]) => void): void; export function subdirs(dir: string, callback: (error: any, subdirs: string[]) => void): void; export function paths(dir: string, callback: (error: any, paths: PathsResult) => void): void; From dc316de06d44bdbc23ccf22d0b9869bdc36dc4fc Mon Sep 17 00:00:00 2001 From: Dmitry Radkovskiy Date: Fri, 2 Sep 2016 14:34:03 +0300 Subject: [PATCH 3/6] removed literal boolean types to pass Travis CI test --- node-dir/node-dir.d.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/node-dir/node-dir.d.ts b/node-dir/node-dir.d.ts index 4ffaf0e093..c1450cf172 100644 --- a/node-dir/node-dir.d.ts +++ b/node-dir/node-dir.d.ts @@ -64,6 +64,5 @@ declare module "node-dir" { export function files(dir: string, callback: (error: any, files: string[]) => void): void; export function subdirs(dir: string, callback: (error: any, subdirs: string[]) => void): void; export function paths(dir: string, callback: (error: any, paths: PathsResult) => void): void; - export function paths(dir: string, combine: true, callback: (error: any, paths: string[]) => void): void; - export function paths(dir: string, combine: false, callback: (error: any, paths: PathsResult) => void): void; + export function paths(dir: string, combine: boolean, callback: (error: any, paths: string[] | PathsResult) => void): void; } From 9d32bda3023b89b75fb1c8289cbc96d9c89cd1a9 Mon Sep 17 00:00:00 2001 From: Dmitry Radkovskiy Date: Fri, 2 Sep 2016 14:38:35 +0300 Subject: [PATCH 4/6] reference node in node-dir tests --- node-dir/node-dir-tests.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/node-dir/node-dir-tests.ts b/node-dir/node-dir-tests.ts index 6cc03ec538..c6442de20f 100644 --- a/node-dir/node-dir-tests.ts +++ b/node-dir/node-dir-tests.ts @@ -1,3 +1,4 @@ +/// /// import * as dir from "node-dir"; From eaebc356556dd02a3a530ae03b50b27b8bfd7017 Mon Sep 17 00:00:00 2001 From: Dmitry Radkovskiy Date: Fri, 2 Sep 2016 14:51:40 +0300 Subject: [PATCH 5/6] reference node in node-dir --- node-dir/node-dir.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/node-dir/node-dir.d.ts b/node-dir/node-dir.d.ts index c1450cf172..40843d3226 100644 --- a/node-dir/node-dir.d.ts +++ b/node-dir/node-dir.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/fshost/node-dir // Definitions by: Panu Horsmalahti // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +/// declare module "node-dir" { import { ReadStream } from "fs"; From 69abf23874bad9cf8dbaa1650cdc6e4cba8c7582 Mon Sep 17 00:00:00 2001 From: Dmitry Radkovskiy Date: Fri, 2 Sep 2016 15:03:32 +0300 Subject: [PATCH 6/6] revert accidental changes --- node-dir/node-dir.d.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/node-dir/node-dir.d.ts b/node-dir/node-dir.d.ts index 40843d3226..3b2c91dea2 100644 --- a/node-dir/node-dir.d.ts +++ b/node-dir/node-dir.d.ts @@ -59,8 +59,10 @@ declare module "node-dir" { dirs: string[]; } - export function readFiles(dir: string, fileCallback: FileCallback | FileNamedCallback, finishedCallback?: FinishedCallback): void; - export function readFiles(dir: string, options: Options, fileCallback: FileCallback | FileNamedCallback, finishedCallback?: FinishedCallback): void; + export function readFiles(dir: string, fileCallback: FileCallback, finishedCallback?: FinishedCallback): void; + export function readFiles(dir: string, fileCallback: FileNamedCallback, finishedCallback?: FinishedCallback): void; + export function readFiles(dir: string, options: Options, fileCallback: FileCallback, finishedCallback?: FinishedCallback): void; + export function readFiles(dir: string, options: Options, fileCallback: FileNamedCallback, finishedCallback?: FinishedCallback): void; export function readFilesStream(dir: string, options: Options, streamCallback: StreamCallback, finishedCallback?: FinishedCallback): void; export function files(dir: string, callback: (error: any, files: string[]) => void): void; export function subdirs(dir: string, callback: (error: any, subdirs: string[]) => void): void;