jsftp-lsr

Recursively get nested files with jsftp, like ls -R

Each directory has a property 'children' with nested files.

Install

$ npm install --save jsftp-lsr

Usage

1var JSFtp = require('jsftp');
2
3// decorate `JSFtp` with a new method `lsr`
4JSFtp = require('jsftp-lsr')(JSFtp);
5
6var path = 'public_html/deploy/foo';
7
8ftp.lsr(path, function (err, data) {
9	console.log('File structure', JSON.stringify(data, null, 2));
10});

Return example

1[
2  {
3    "name": "bar",
4    "type": 1,
5    "time": 1462024620000,
6    "size": "102",
7    "owner": "ivan",
8    "group": "staff",
9    "userPermissions": {
10      "read": true,
11      "write": true,
12      "exec": true
13    },
14    "groupPermissions": {
15      "read": true,
16      "write": false,
17      "exec": true
18    },
19    "otherPermissions": {
20      "read": true,
21      "write": false,
22      "exec": true
23    },
24    "children": [
25      {
26        "name": "test.txt",
27        "type": 0,
28        "time": 1462024620000,
29        "size": "4",
30        "owner": "ivan",
31        "group": "staff",
32        "userPermissions": {
33          "read": true,
34          "write": true,
35          "exec": false
36        },
37        "groupPermissions": {
38          "read": true,
39          "write": false,
40          "exec": false
41        },
42        "otherPermissions": {
43          "read": true,
44          "write": false,
45          "exec": false
46        }
47      }
48    ]
49  },
50  {
51    "name": "baz",
52    "type": 1,
53    "time": 1462024620000,
54    "size": "68",
55    "owner": "ivan",
56    "group": "staff",
57    "userPermissions": {
58      "read": true,
59      "write": true,
60      "exec": true
61    },
62    "groupPermissions": {
63      "read": true,
64      "write": false,
65      "exec": true
66    },
67    "otherPermissions": {
68      "read": true,
69      "write": false,
70      "exec": true
71    },
72    "children": []
73  }
74]

API

JSFtp.lsr(path, callback)

path

Required
Type: string

Path of the directory which you want to see.

License

MIT © Ivan Drondov