ftp-response-parser

This module provides a fast, lightweight streaming parser for FTP response format strings.

Given a string like this:

211-Features supported:\n
 EPRT\n
 EPSV\n
 MDTM\n
 MLST type*;perm*;size*;modify*;unique*;unix.mode;unix.uid;unix.gid;\n
 REST STREAM\n
 SIZE\n
 TVFS\n
 UTF8\n
211 End FEAT.\n
215 UNIX Type: L8\n
331 Username ok, send password.\n
230 Login successful.\n
200 Type set to: Binary.\n
250 "/test" is the current directory.\n

it will stream the following objects:

1{
2  code: 211,
3  text: '211-Features supported:\n EPRT\n EPSV\n MDTM\n MLST type*;perm*;size*;modify*;unique*;unix.mode;unix.uid;unix.gid;\n REST STREAM\n SIZE\n TVFS\n UTF8\n211 End FEAT.',
4  isMark: false,
5  isError: false
6}
7{
8  code: 215,
9  text: '215 UNIX Type: L8',
10  isMark: false,
11  isError: false
12}
13{
14  code: 331,
15  text: '331 Username ok, send password.',
16  isMark: false,
17  isError: false
18}
19{
20  code: 230,
21  text: '230 Login successful.',
22  isMark: false,
23  isError: false
24}
25{
26  code: 200,
27  text: '200 Type set to: Binary.',
28  isMark: false,
29  isError: false
30}
31{
32  code: 250,
33  text: '250 "/test" is the current directory.',
34  isMark: false,
35  isError: false
36}

Usage

1
2var ResponseParser = require('ftp-response-parser');
3
4var myParser = new ResponseParser();
5
6myParser.on('readable', function() {
7  var line;
8  while (line = myParser.read()) {
9    console.log(line.code); // will emit 215
10  }
11});
12
13myParser.write('215 UNIX Type: L8');
14

Install

To get the module, with npm do:

npm install ftp-response-parser

Test

With npm do:

npm test

License

MIT