From 29cb035f66ad9dc8101cd3ab74c614e0468e0895 Mon Sep 17 00:00:00 2001 From: Tyler Stewart Date: Sun, 24 Jun 2018 22:52:40 -0600 Subject: [PATCH] chore: migration guide v2 to v3 --- changelog/v2_to_v3_migation.md | 44 ++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 changelog/v2_to_v3_migation.md diff --git a/changelog/v2_to_v3_migation.md b/changelog/v2_to_v3_migation.md new file mode 100644 index 00000000..e91515dc --- /dev/null +++ b/changelog/v2_to_v3_migation.md @@ -0,0 +1,44 @@ +# Migration Guide - v2 to v3 + +The `FtpServer` constructor has been changed to only take one object option. Combining the two just made sense. + +### From: + +```js +const server = new FtpServer('ftp://0.0.0.0:21'); +``` + +### To: + +```js +const server = new FtpServer({ + url: 'ftp://0.0.0.0:21' +}); +``` + +---- + +The `pasv_range` option has been changed to separate integer variables: `pasv_min`, `pasv_max`. + +### From: + +```js +const server = new FtpServer(..., { + pasv_range: '1000-2000' +}); +``` + +### To: + +```js +const server = new FtpServer({ + pasv_min: 1000, + pasv_max: 2000 +}) +``` + +---- + +The default passive port range has been changed to `1024` - `65535` + +---- \ No newline at end of file