@types/jsftp - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

jsftp/index.d.ts

@@ -12,8 +12,8 @@ // Type definitions for jsftp 2.1
 export interface JsftpOpts {
-    host?: string;
-    port?: number;
-    user?: string;
-    pass?: string;
-    createSocket?: ({ port, host }: { port: number, host: string }, firstAction: () => {}) => Socket;
-    useList?: boolean;
+    host?: string | undefined;
+    port?: number | undefined;
+    user?: string | undefined;
+    pass?: string | undefined;
+    createSocket?: (({ port, host }: { port: number, host: string }, firstAction: () => {}) => Socket) | undefined;
+    useList?: boolean | undefined;
 }
@@ -20,0 +20,0 @@

jsftp/package.json

 {
     "name": "@types/jsftp",
-    "version": "2.1.0",
+    "version": "2.1.1",
     "description": "TypeScript definitions for jsftp",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsftp",
     "license": "MIT",
@@ -14,13 +15,14 @@ "contributors": [
     "main": "",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/jsftp"
     },
     "scripts": {},
     "dependencies": {
-        "@types/events": "*",
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "45d0e203f75728c786962cc7d1d49f7c3b970a1ce431da1eaddbc7ccc7159fd7",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "0ddee6b3ca74d18f897c7e08f38b0a96657ab535bad53f8cbe7108762010be84",
+    "typeScriptVersion": "3.6"
 }

jsftp/README.md

@@ -8,10 +8,64 @@ # Installation
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsftp
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsftp.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsftp/index.d.ts)
+````ts
+// Type definitions for jsftp 2.1
+// Project: https://github.com/sergi/jsftp
+// Definitions by: Konrad Księski <https://github.com/xyleen>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
-Additional Details
- * Last updated: Sat, 08 Sep 2018 01:20:16 GMT
- * Dependencies: net, events, node
+/// <reference types="node" />
+
+import { Socket } from 'net';
+import { EventEmitter } from 'events';
+
+export interface JsftpOpts {
+    host?: string | undefined;
+    port?: number | undefined;
+    user?: string | undefined;
+    pass?: string | undefined;
+    createSocket?: (({ port, host }: { port: number, host: string }, firstAction: () => {}) => Socket) | undefined;
+    useList?: boolean | undefined;
+}
+
+export type ErrorCallback = (err: Error) => void;
+export type RawCallback = (err: Error, data: { code: number, text: string }) => void;
+export type ListCallback = (err: Error, dirContents: string) => void;
+export type GetCallback = (err: Error, socket: Socket) => void;
+export type LsCallback = (err: Error, res: [{ name: string }]) => void;
+
+export default class Ftp extends EventEmitter {
+    constructor(opts: JsftpOpts);
+
+    ls(filePath: string, callback: LsCallback): void;
+
+    list(filePath: string, callback: ListCallback): void;
+
+    get(remotePath: string, callback: GetCallback): void;
+    get(remotePath: string, localPath: string, callback: ErrorCallback): void;
+
+    put(source: string | Buffer | NodeJS.ReadableStream, remotePath: string, callback: ErrorCallback): void;
+
+    rename(from: string, to: string, callback: ErrorCallback): void;
+
+    // Ftp.raw(command, params, callback)
+    raw(command: string, callback: RawCallback): void;
+    raw(command: string, arg1: any, callback: RawCallback): void;
+    raw(command: string, arg1: any, arg2: any, callback: RawCallback): void;
+    raw(command: string, arg1: any, arg2: any, arg3: any, callback: RawCallback): void;
+    raw(command: string, arg1: any, arg2: any, arg3: any, arg4: any, callback: RawCallback): void;
+
+    keepAlive(timeInMs?: number): void;
+
+    destroy(): void;
+}
+
+````
+
+### Additional Details
+ * Last updated: Thu, 08 Jul 2021 16:22:48 GMT
+ * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 
 # Credits
-These definitions were written by Konrad Księski <https://github.com/xyleen>.
+These definitions were written by [Konrad Księski](https://github.com/xyleen).

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6532

increased by54.64%

Dependency count

1

decreased by-50%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

71

increased by317.65%

Dependency changes

• - Removed@types/events@*

• - Removed@types/events@3.0.3(transitive)