docs: regen docs

jeanbmar · May 24, 2023 · 1278d93 · 1278d93
1 parent 7c529f6
commit 1278d93
Show file tree

Hide file tree

Showing 23 changed files with 204 additions and 207 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -180,8 +180,8 @@ await sync('s3://my-source-bucket', 's3://my-target-bucket', {
 #### Relocate objects during sync
 
 ```javascript
-// sync s3://my-source-bucket/a/b/c.txt to s3://my-target-bucket/zzz/c.txt
-await sync('s3://my-source-bucket/a/b/c.txt', 's3://my-target-bucket', {
+// move objects from source folder a/b/ to target folder zzz/
+await sync('s3://my-source-bucket', 's3://my-target-bucket', {
     relocations: [ // multiple relocations can be applied
       (currentPath) =>
         currentPath.startsWith('a/b/')
@@ -190,12 +190,9 @@ await sync('s3://my-source-bucket/a/b/c.txt', 's3://my-target-bucket', {
     ],
 });
 
-// sync s3://mybucket/flowers/red/rose.png to /path/to/local/dir/rose.png
-await sync('s3://mybucket/flowers/red/rose.png', '/path/to/local/dir', {
-    relocations: [
-      (currentPath) => currentPath.replace('flowers/red/', '') // folder flowers/red will be flattened during sync
-    ],
-});
+// aws s3 sync s3://mybucket/flowers/red /path/to/local/dir
+// as in cli, folder flowers/red will be flattened during sync
+await sync('s3://mybucket/flowers/red', '/path/to/local/dir'); 
 ```
 
 Note: relocations are applied after every other options such as filters.

diff --git a/docs/classes/BucketObject.md b/docs/classes/BucketObject.md
@@ -52,7 +52,7 @@
 
 #### Defined in
 
-[src/fs/BucketObject.ts:12](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/BucketObject.ts#L12)
+[src/fs/BucketObject.ts:12](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/BucketObject.ts#L12)
 
 ## Properties
 
@@ -62,7 +62,7 @@
 
 #### Defined in
 
-[src/fs/BucketObject.ts:9](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/BucketObject.ts#L9)
+[src/fs/BucketObject.ts:9](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/BucketObject.ts#L9)
 
 ___
 
@@ -76,7 +76,7 @@ ___
 
 #### Defined in
 
-[src/fs/SyncObject.ts:16](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L16)
+[src/fs/SyncObject.ts:16](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L16)
 
 ___
 
@@ -86,7 +86,7 @@ ___
 
 #### Defined in
 
-[src/fs/BucketObject.ts:10](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/BucketObject.ts#L10)
+[src/fs/BucketObject.ts:10](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/BucketObject.ts#L10)
 
 ___
 
@@ -100,7 +100,7 @@ ___
 
 #### Defined in
 
-[src/fs/SyncObject.ts:18](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L18)
+[src/fs/SyncObject.ts:18](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L18)
 
 ___
 
@@ -114,7 +114,7 @@ ___
 
 #### Defined in
 
-[src/fs/SyncObject.ts:17](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L17)
+[src/fs/SyncObject.ts:17](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L17)
 
 ## Accessors
 
@@ -132,7 +132,7 @@ SyncObject.isIncluded
 
 #### Defined in
 
-[src/fs/SyncObject.ts:60](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L60)
+[src/fs/SyncObject.ts:60](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L60)
 
 ## Methods
 
@@ -156,7 +156,7 @@ SyncObject.isIncluded
 
 #### Defined in
 
-[src/fs/SyncObject.ts:64](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L64)
+[src/fs/SyncObject.ts:64](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L64)
 
 ___
 
@@ -181,7 +181,7 @@ ___
 
 #### Defined in
 
-[src/fs/SyncObject.ts:75](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L75)
+[src/fs/SyncObject.ts:75](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L75)
 
 ___
 
@@ -205,7 +205,7 @@ ___
 
 #### Defined in
 
-[src/fs/SyncObject.ts:87](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L87)
+[src/fs/SyncObject.ts:87](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L87)
 
 ___
 
@@ -229,7 +229,7 @@ ___
 
 #### Defined in
 
-[src/fs/SyncObject.ts:95](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L95)
+[src/fs/SyncObject.ts:95](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L95)
 
 ___
 
@@ -255,4 +255,4 @@ ___
 
 #### Defined in
 
-[src/fs/SyncObject.ts:27](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/fs/SyncObject.ts#L27)
+[src/fs/SyncObject.ts:27](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/fs/SyncObject.ts#L27)
diff --git a/docs/classes/CompleteMultipartLocalObjectCommand.md b/docs/classes/CompleteMultipartLocalObjectCommand.md
@@ -33,7 +33,7 @@
 
 #### Defined in
 
-[src/commands/CompleteMultipartLocalObjectCommand.ts:22](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CompleteMultipartLocalObjectCommand.ts#L22)
+[src/commands/CompleteMultipartLocalObjectCommand.ts:22](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CompleteMultipartLocalObjectCommand.ts#L22)
 
 ## Properties
 
@@ -43,7 +43,7 @@
 
 #### Defined in
 
-[src/commands/CompleteMultipartLocalObjectCommand.ts:19](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CompleteMultipartLocalObjectCommand.ts#L19)
+[src/commands/CompleteMultipartLocalObjectCommand.ts:19](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CompleteMultipartLocalObjectCommand.ts#L19)
 
 ___
 
@@ -53,7 +53,7 @@ ___
 
 #### Defined in
 
-[src/commands/CompleteMultipartLocalObjectCommand.ts:18](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CompleteMultipartLocalObjectCommand.ts#L18)
+[src/commands/CompleteMultipartLocalObjectCommand.ts:18](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CompleteMultipartLocalObjectCommand.ts#L18)
 
 ___
 
@@ -63,7 +63,7 @@ ___
 
 #### Defined in
 
-[src/commands/CompleteMultipartLocalObjectCommand.ts:21](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CompleteMultipartLocalObjectCommand.ts#L21)
+[src/commands/CompleteMultipartLocalObjectCommand.ts:21](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CompleteMultipartLocalObjectCommand.ts#L21)
 
 ___
 
@@ -73,7 +73,7 @@ ___
 
 #### Defined in
 
-[src/commands/CompleteMultipartLocalObjectCommand.ts:20](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CompleteMultipartLocalObjectCommand.ts#L20)
+[src/commands/CompleteMultipartLocalObjectCommand.ts:20](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CompleteMultipartLocalObjectCommand.ts#L20)
 
 ## Methods
 
@@ -93,4 +93,4 @@ ___
 
 #### Defined in
 
-[src/commands/CompleteMultipartLocalObjectCommand.ts:29](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CompleteMultipartLocalObjectCommand.ts#L29)
+[src/commands/CompleteMultipartLocalObjectCommand.ts:29](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CompleteMultipartLocalObjectCommand.ts#L29)
diff --git a/docs/classes/CopyBucketObjectCommand.md b/docs/classes/CopyBucketObjectCommand.md
@@ -34,7 +34,7 @@
 
 #### Defined in
 
-[src/commands/CopyBucketObjectCommand.ts:26](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectCommand.ts#L26)
+[src/commands/CopyBucketObjectCommand.ts:26](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectCommand.ts#L26)
 
 ## Properties
 
@@ -44,7 +44,7 @@
 
 #### Defined in
 
-[src/commands/CopyBucketObjectCommand.ts:22](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectCommand.ts#L22)
+[src/commands/CopyBucketObjectCommand.ts:22](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectCommand.ts#L22)
 
 ___
 
@@ -54,7 +54,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectCommand.ts:20](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectCommand.ts#L20)
+[src/commands/CopyBucketObjectCommand.ts:20](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectCommand.ts#L20)
 
 ___
 
@@ -64,7 +64,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectCommand.ts:23](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectCommand.ts#L23)
+[src/commands/CopyBucketObjectCommand.ts:23](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectCommand.ts#L23)
 
 ___
 
@@ -74,7 +74,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectCommand.ts:24](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectCommand.ts#L24)
+[src/commands/CopyBucketObjectCommand.ts:24](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectCommand.ts#L24)
 
 ___
 
@@ -84,7 +84,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectCommand.ts:21](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectCommand.ts#L21)
+[src/commands/CopyBucketObjectCommand.ts:21](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectCommand.ts#L21)
 
 ## Methods
 
@@ -104,4 +104,4 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectCommand.ts:34](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectCommand.ts#L34)
+[src/commands/CopyBucketObjectCommand.ts:34](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectCommand.ts#L34)
diff --git a/docs/classes/CopyBucketObjectsCommand.md b/docs/classes/CopyBucketObjectsCommand.md
@@ -35,7 +35,7 @@
 
 #### Defined in
 
-[src/commands/CopyBucketObjectsCommand.ts:30](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectsCommand.ts#L30)
+[src/commands/CopyBucketObjectsCommand.ts:30](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectsCommand.ts#L30)
 
 ## Properties
 
@@ -45,7 +45,7 @@
 
 #### Defined in
 
-[src/commands/CopyBucketObjectsCommand.ts:25](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectsCommand.ts#L25)
+[src/commands/CopyBucketObjectsCommand.ts:25](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectsCommand.ts#L25)
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectsCommand.ts:23](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectsCommand.ts#L23)
+[src/commands/CopyBucketObjectsCommand.ts:23](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectsCommand.ts#L23)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectsCommand.ts:26](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectsCommand.ts#L26)
+[src/commands/CopyBucketObjectsCommand.ts:26](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectsCommand.ts#L26)
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectsCommand.ts:28](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectsCommand.ts#L28)
+[src/commands/CopyBucketObjectsCommand.ts:28](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectsCommand.ts#L28)
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectsCommand.ts:27](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectsCommand.ts#L27)
+[src/commands/CopyBucketObjectsCommand.ts:27](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectsCommand.ts#L27)
 
 ___
 
@@ -95,7 +95,7 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectsCommand.ts:24](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectsCommand.ts#L24)
+[src/commands/CopyBucketObjectsCommand.ts:24](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectsCommand.ts#L24)
 
 ## Methods
 
@@ -115,4 +115,4 @@ ___
 
 #### Defined in
 
-[src/commands/CopyBucketObjectsCommand.ts:40](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CopyBucketObjectsCommand.ts#L40)
+[src/commands/CopyBucketObjectsCommand.ts:40](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CopyBucketObjectsCommand.ts#L40)
diff --git a/docs/classes/CreateMultipartLocalObjectUploadCommand.md b/docs/classes/CreateMultipartLocalObjectUploadCommand.md
@@ -32,7 +32,7 @@
 
 #### Defined in
 
-[src/commands/CreateMultipartLocalObjectUploadCommand.ts:19](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L19)
+[src/commands/CreateMultipartLocalObjectUploadCommand.ts:19](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L19)
 
 ## Properties
 
@@ -42,7 +42,7 @@
 
 #### Defined in
 
-[src/commands/CreateMultipartLocalObjectUploadCommand.ts:17](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L17)
+[src/commands/CreateMultipartLocalObjectUploadCommand.ts:17](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L17)
 
 ___
 
@@ -52,7 +52,7 @@ ___
 
 #### Defined in
 
-[src/commands/CreateMultipartLocalObjectUploadCommand.ts:18](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L18)
+[src/commands/CreateMultipartLocalObjectUploadCommand.ts:18](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L18)
 
 ___
 
@@ -62,7 +62,7 @@ ___
 
 #### Defined in
 
-[src/commands/CreateMultipartLocalObjectUploadCommand.ts:16](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L16)
+[src/commands/CreateMultipartLocalObjectUploadCommand.ts:16](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L16)
 
 ## Methods
 
@@ -82,4 +82,4 @@ ___
 
 #### Defined in
 
-[src/commands/CreateMultipartLocalObjectUploadCommand.ts:25](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L25)
+[src/commands/CreateMultipartLocalObjectUploadCommand.ts:25](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/CreateMultipartLocalObjectUploadCommand.ts#L25)
diff --git a/docs/classes/DeleteBucketObjectsCommand.md b/docs/classes/DeleteBucketObjectsCommand.md
@@ -31,7 +31,7 @@
 
 #### Defined in
 
-[src/commands/DeleteBucketObjectsCommand.ts:18](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/DeleteBucketObjectsCommand.ts#L18)
+[src/commands/DeleteBucketObjectsCommand.ts:18](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/DeleteBucketObjectsCommand.ts#L18)
 
 ## Properties
 
@@ -41,7 +41,7 @@
 
 #### Defined in
 
-[src/commands/DeleteBucketObjectsCommand.ts:15](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/DeleteBucketObjectsCommand.ts#L15)
+[src/commands/DeleteBucketObjectsCommand.ts:15](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/DeleteBucketObjectsCommand.ts#L15)
 
 ___
 
@@ -51,7 +51,7 @@ ___
 
 #### Defined in
 
-[src/commands/DeleteBucketObjectsCommand.ts:16](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/DeleteBucketObjectsCommand.ts#L16)
+[src/commands/DeleteBucketObjectsCommand.ts:16](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/DeleteBucketObjectsCommand.ts#L16)
 
 ## Methods
 
@@ -71,4 +71,4 @@ ___
 
 #### Defined in
 
-[src/commands/DeleteBucketObjectsCommand.ts:23](https://github.com/jeanbmar/s3-sync-client/blob/3b5f6c4/src/commands/DeleteBucketObjectsCommand.ts#L23)
+[src/commands/DeleteBucketObjectsCommand.ts:23](https://github.com/jeanbmar/s3-sync-client/blob/7c529f6/src/commands/DeleteBucketObjectsCommand.ts#L23)