fix(docs): fix docs typos

nfroidure · May 26, 2022 · adf7ba8 · adf7ba8
1 parent a29e858
commit adf7ba8
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 8 deletions.
diff --git a/API.md b/API.md
@@ -27,16 +27,17 @@ import { initDelayService } from 'common-services';
 const delay = await initDelayService({
   log: console.log.bind(console),
 })
-const jwt = await initFTPService({
+const fpt = await initFTPService({
   FTP: {
     host: 'localhost',
     user: 'user',
     pasword: 'pwd',
   },
   FTP_CONFIG: { base: '' },
+  ENV: process.env,
   delay,
   log: console.log.bind(console),
 });
 
-const files = await ftp.list('/);
+const files = await ftp.list('/');
 ```
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
@@ -27,7 +27,7 @@ The `ftp` service creates easily usable FTP features
 The service uses a pool to allow several parallel connections
  to a FTP server.
 
-[See in context](./src/index.ts#L146-L150)
+[See in context](./src/index.ts#L147-L151)
 
 
 
@@ -36,5 +36,5 @@ The service uses a pool to allow several parallel connections
 One can configure the FTP service to retry several times
  before abandonnating the requested operation.
 
-[See in context](./src/index.ts#L354-L358)
+[See in context](./src/index.ts#L355-L359)
 
diff --git a/README.md b/README.md
@@ -46,18 +46,19 @@ import { initDelayService } from 'common-services';
 const delay = await initDelayService({
   log: console.log.bind(console),
 })
-const ftp = await initFTPService({
+const fpt = await initFTPService({
   FTP: {
     host: 'localhost',
     user: 'user',
     pasword: 'pwd',
   },
   FTP_CONFIG: { base: '' },
+  ENV: process.env,
   delay,
   log: console.log.bind(console),
 });
 
-const files = await ftp.list('/);
+const files = await ftp.list('/');
 ```
 
 # Authors

diff --git a/src/index.ts b/src/index.ts
@@ -116,18 +116,19 @@ export default provider(
  * const delay = await initDelayService({
  *   log: console.log.bind(console),
  * })
- * const jwt = await initFTPService({
+ * const fpt = await initFTPService({
  *   FTP: {
  *     host: 'localhost',
  *     user: 'user',
  *     pasword: 'pwd',
  *   },
  *   FTP_CONFIG: { base: '' },
+ *   ENV: process.env,
  *   delay,
  *   log: console.log.bind(console),
  * });
  *
- * const files = await ftp.list('/);
+ * const files = await ftp.list('/');
  */
 async function initFTPService<
   T extends string extends T