@types/fs-extra-promise - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

fs-extra-promise/index.d.ts

 // Type definitions for fs-extra-promise 1.0
 // Project: https://github.com/overlookmotel/fs-extra-promise
-// Definitions by: midknight41 <https://github.com/midknight41>, Jason Swearingen <https://github.com/jasonswearingen>
+// Definitions by: midknight41 <https://github.com/midknight41>, Jason Swearingen <https://github.com/jasonswearingen>, Hiromi Shikata <https://github.com/HiromiShikata>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.2
+// TypeScript Version: 2.3
 
 /// <reference types="node" />
-/// <reference types="bluebird" />
-/// <reference types="fs-extra" />
 
@@ -23,71 +21,92 @@ import * as stream from 'stream';
 
-//promisified versions
-export declare function copyAsync(src: string, dest: string): Promise<void>;
-export declare function copyAsync(src: string, dest: string, filter: CopyFilter): Promise<void>;
-export declare function copyAsync(src: string, dest: string, options: CopyOptions): Promise<void>;
+// promisified versions
+/**
+ * copyAsync
+ * @param src
+ * @param dest
+ * @param options
+ *              CopyFilter: filter
+ *              CopyOptions: options
+ */
+export function copyAsync(src: string, dest: string, options?: CopyFilter | CopyOptions): Promise<void>;
 
-export declare function createFileAsync(file: string): Promise<void>;
+export function createFileAsync(file: string): Promise<void>;
 
-export declare function mkdirsAsync(dir: string, options?: MkdirOptions): Promise<void>;
-export declare function mkdirpAsync(dir: string, options?: MkdirOptions): Promise<void>;
+export function mkdirsAsync(dir: string, options?: MkdirOptions): Promise<void>;
+export function mkdirpAsync(dir: string, options?: MkdirOptions): Promise<void>;
 
-export declare function moveAsync(src: string, dest: string, options?: MoveOptions): Promise<void>;
+export function moveAsync(src: string, dest: string, options?: MoveOptions): Promise<void>;
 
-export declare function outputFileAsync(file: string, data: any): Promise<void>;
+export function outputFileAsync(file: string, data: any): Promise<void>;
 
-export declare function outputJsonAsync(file: string, data: any): Promise<void>;
-export declare function outputJSONAsync(file: string, data: any): Promise<void>;
+export function outputJsonAsync(file: string, data: any): Promise<void>;
+export function outputJSONAsync(file: string, data: any): Promise<void>;
 
-export declare function readJsonAsync(file: string): Promise<any>;
-export declare function readJsonAsync(file: string, options?: ReadOptions): Promise<any>;
-export declare function readJSONAsync(file: string): Promise<any>;
-export declare function readJSONAsync(file: string, options?: ReadOptions): Promise<any>;
+export function readJsonAsync(file: string, options?: ReadOptions): Promise<any>;
+export function readJSONAsync(file: string, options?: ReadOptions): Promise<any>;
 
-export declare function removeAsync(dir: string): Promise<void>;
+export function removeAsync(dir: string): Promise<void>;
 
-export declare function writeJsonAsync(file: string, object: any): Promise<void>;
-export declare function writeJsonAsync(file: string, object: any, options?: WriteOptions): Promise<void>;
-export declare function writeJSONAsync(file: string, object: any): Promise<void>;
-export declare function writeJSONAsync(file: string, object: any, options?: WriteOptions): Promise<void>;
+export function writeJsonAsync(file: string, object: any, options?: WriteOptions): Promise<void>;
+export function writeJSONAsync(file: string, object: any, options?: WriteOptions): Promise<void>;
 
-export declare function renameAsync(oldPath: string, newPath: string): Promise<void>;
-export declare function truncateAsync(fd: number, len: number): Promise<void>;
-export declare function chownAsync(path: string, uid: number, gid: number): Promise<void>;
-export declare function fchownAsync(fd: number, uid: number, gid: number): Promise<void>;
-export declare function lchownAsync(path: string, uid: number, gid: number): Promise<void>;
-export declare function chmodAsync(path: string, mode: number): Promise<void>;
-export declare function chmodAsync(path: string, mode: string): Promise<void>;
-export declare function fchmodAsync(fd: number, mode: number): Promise<void>;
-export declare function fchmodAsync(fd: number, mode: string): Promise<void>;
-export declare function lchmodAsync(path: string, mode: string): Promise<void>;
-export declare function lchmodAsync(path: string, mode: number): Promise<void>;
-export declare function statAsync(path: string): Promise<Stats>;
-export declare function lstatAsync(path: string): Promise<Stats>;
-export declare function fstatAsync(fd: number): Promise<Stats>;
-export declare function linkAsync(srcpath: string, dstpath: string): Promise<void>;
-export declare function symlinkAsync(srcpath: string, dstpath: string, type?: string): Promise<void>;
-export declare function readlinkAsync(path: string): Promise<string>;
-export declare function realpathAsync(path: string): Promise<string>;
-export declare function realpathAsync(path: string, cache: { [path: string]: string }): Promise<string>;
-export declare function unlinkAsync(path: string): Promise<void>;
-export declare function rmdirAsync(path: string): Promise<void>;
-export declare function mkdirAsync(path: string, mode?: number): Promise<void>;
-export declare function mkdirAsync(path: string, mode?: string): Promise<void>;
-export declare function readdirAsync(path: string): Promise<string[]>;
-export declare function closeAsync(fd: number): Promise<void>;
-export declare function openAsync(path: string, flags: string, mode?: string): Promise<number>;
-export declare function utimesAsync(path: string, atime: number, mtime: number): Promise<void>;
-export declare function futimesAsync(fd: number, atime: number, mtime: number): Promise<void>;
-export declare function fsyncAsync(fd: number): Promise<void>;
-export declare function writeAsync(fd: number, buffer: NodeBuffer, offset: number, length: number, position: number): Promise<[number, NodeBuffer]>;
-export declare function readAsync(fd: number, buffer: NodeBuffer, offset: number, length: number, position: number): Promise<[number, NodeBuffer]>;
-export declare function readFileAsync(filename: string, encoding: string): Promise<string>;
-export declare function readFileAsync(filename: string, options: ReadOptions): Promise<string>;
-export declare function readFileAsync(filename: string): Promise<NodeBuffer>;
-export declare function writeFileAsync(filename: string, data: any, encoding?: string): Promise<void>;
-export declare function writeFileAsync(filename: string, data: any, options?: WriteOptions): Promise<void>;
-export declare function appendFileAsync(filename: string, data: any, encoding?: string): Promise<void>;
-export declare function appendFileAsync(filename: string, data: any, option?: WriteOptions): Promise<void>;
+export function renameAsync(oldPath: string, newPath: string): Promise<void>;
+export function truncateAsync(fd: number, len: number): Promise<void>;
+export function chownAsync(path: string, uid: number, gid: number): Promise<void>;
+export function fchownAsync(fd: number, uid: number, gid: number): Promise<void>;
+export function lchownAsync(path: string, uid: number, gid: number): Promise<void>;
+export function chmodAsync(path: string, mode: number | string): Promise<void>;
+export function fchmodAsync(fd: number, mode: number | string): Promise<void>;
+export function lchmodAsync(path: string, mode: number | string): Promise<void>;
+export function statAsync(path: string): Promise<Stats>;
+export function lstatAsync(path: string): Promise<Stats>;
+export function fstatAsync(fd: number): Promise<Stats>;
+export function linkAsync(srcpath: string, dstpath: string): Promise<void>;
+export function symlinkAsync(srcpath: string, dstpath: string, type?: string): Promise<void>;
+export function readlinkAsync(path: string): Promise<string>;
+export function realpathAsync(path: string, cache?: { [path: string]: string }): Promise<string>;
+export function unlinkAsync(path: string): Promise<void>;
+export function rmdirAsync(path: string): Promise<void>;
+export function mkdirAsync(path: string, mode?: number | string): Promise<void>;
+export function readdirAsync(path: string): Promise<string[]>;
+export function closeAsync(fd: number): Promise<void>;
+export function openAsync(path: string, flags: string, mode?: string): Promise<number>;
+export function utimesAsync(path: string, atime: number, mtime: number): Promise<void>;
+export function futimesAsync(fd: number, atime: number, mtime: number): Promise<void>;
+export function fsyncAsync(fd: number): Promise<void>;
+export function writeAsync(fd: number, buffer: NodeBuffer, offset: number, length: number, position: number): Promise<[number, NodeBuffer]>;
+export function readAsync(fd: number, buffer: NodeBuffer, offset: number, length: number, position: number): Promise<[number, NodeBuffer]>;
+/**
+ * readFileAsync
+ * @param filename
+ * @param options:
+ *              string: encoding
+ *              ReadOptions: options
+ */
+export function readFileAsync(filename: string, options: string | ReadOptions): Promise<string>;
+export function readFileAsync(filename: string): Promise<NodeBuffer>;
+/**
+ * writeFileAsync
+ * @param filename
+ * @param data
+ * @param options:
+ *              string: encoding
+ *              WriteOptions: options
+ */
+export function writeFileAsync(filename: string, data: any, options?: string | WriteOptions): Promise<void>;
+/**
+ * appendFileAsync
+ * @param filename
+ * @param data
+ * @param options:
+ *              string: encoding
+ *              WriteOptions: options
+ */
+export function appendFileAsync(filename: string, data: any, option?: string | WriteOptions): Promise<void>;
 
-export declare function existsAsync(path: string): Promise<boolean>;
-export declare function ensureDirAsync(path: string): Promise<void>;
+export function existsAsync(path: string): Promise<boolean>;
+export function ensureDirAsync(path: string): Promise<void>;
+
+export function isDirectory(path: string, callback?: (err: Error, isDirectory: boolean) => void): void;
+export function isDirectorySync(path: string): boolean;
+export function isDirectoryAsync(path: string): Promise<boolean>;

fs-extra-promise/package.json

 {
     "name": "@types/fs-extra-promise",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "TypeScript definitions for fs-extra-promise",
@@ -14,2 +14,6 @@ "license": "MIT",
             "url": "https://github.com/jasonswearingen"
+        },
+        {
+            "name": "Hiromi Shikata",
+            "url": "https://github.com/HiromiShikata"
         }
@@ -29,4 +33,4 @@ ],
     "peerDependencies": {},
-    "typesPublisherContentHash": "6ad1a18b46857cea6aefccae913a4c1cfe3670d64301bcd98499015ee8ce2e21",
-    "typeScriptVersion": "2.2"
+    "typesPublisherContentHash": "713ef91162c7b2f4337d37b11005252d4e16eee8035cc37fef08edb44e394832",
+    "typeScriptVersion": "2.3"
 }

fs-extra-promise/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Mon, 01 May 2017 20:59:40 GMT
+ * Last updated: Tue, 20 Jun 2017 20:20:01 GMT
  * Dependencies: stream, fs, bluebird, fs-extra, node
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by midknight41 <https://github.com/midknight41>, Jason Swearingen <https://github.com/jasonswearingen>.
+These definitions were written by midknight41 <https://github.com/midknight41>, Jason Swearingen <https://github.com/jasonswearingen>, Hiromi Shikata <https://github.com/HiromiShikata>.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

95

increased by23.38%

Worsened metrics

Total package byte prevSize

7934

decreased by-7.1%

No dependency changes