chore: cr nits

Author: lukachad

lib/lib-storage/src/s3-transfer-manager/README.md

@@ -124,13 +124,13 @@ Downloads objects from S3 using multipart download with two modes:
 
 **PART Mode:**
 
-- Optimized for objects uploaded via multipart upload
-- Uses S3's native PartNumber parameter to download parts concurrently
+- Optimized for objects uploaded via multipart upload.
+- Uses S3's native PartNumber parameter to download parts concurrently.
 
 **RANGE Mode:**
 
-- Works with any S3 object regardless of upload method
-- Uses HTTP Range headers to split objects into chunks for concurrent download
+- Works with any S3 object regardless of upload method.
+- Uses HTTP Range headers to split objects into chunks for concurrent download.
 
 Both modes join separate streams into a single stream and support Readable/ReadableStream for Node.js and browsers.
 
@@ -158,10 +158,10 @@ Both modes join separate streams into a single stream and support Readable/Reada
 
 Both modes validate data integrity:
 
-- **PART**: Validates part boundaries match expected byte ranges
-- **RANGE**: Validates byte ranges match expected values
-- Uses `IfMatch` header with initial ETag to ensure object consistency
-- Throws errors and cancels download on validation failures
+- **PART**: Validates part boundaries match expected byte ranges.
+- **RANGE**: Validates byte ranges match expected values.
+- Uses `IfMatch` header with initial ETag to ensure object consistency.
+- Throws errors and cancels download on validation failures.
 
 We do not recommend updating the object you're downloading mid-download as this may throw a [Precondition Failed error](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/http-412-precondition-failed.html).
 

lib/lib-storage/src/s3-transfer-manager/S3TransferManager.ts

@@ -74,6 +74,16 @@ export class S3TransferManager implements IS3TransferManager {
     this.validateConfig();
   }
 
+  /**
+   * Registers a callback function to be executed when a specific transfer event occurs.
+   * Supports monitoring the full lifecycle of transfers.
+   *
+   * @param type - The type of event to listen for.
+   * @param callback - Function to execute when the specified event occurs.
+   * @param options - Optional configuration for event listener behavior.
+   *
+   * @alpha
+   */
   public addEventListener(
     type: "transferInitiated",
     callback: EventListener<TransferEvent>,
@@ -95,16 +105,6 @@ export class S3TransferManager implements IS3TransferManager {
     options?: AddEventListenerOptions | boolean
   ): void;
   public addEventListener(type: string, callback: EventListener, options?: AddEventListenerOptions | boolean): void;
-  /**
-   * Registers a callback function to be executed when a specific transfer event occurs.
-   * Supports monitoring the full lifecycle of transfers.
-   *
-   * @param type - The type of event to listen for.
-   * @param callback - Function to execute when the specified event occurs.
-   * @param options - Optional configuration for event listener behavior.
-   *
-   * @alpha
-   */
   public addEventListener(type: string, callback: EventListener, options?: AddEventListenerOptions | boolean): void {
     const eventType = type as keyof TransferEventListeners;
     const listeners = this.eventListeners[eventType];
@@ -144,9 +144,6 @@ export class S3TransferManager implements IS3TransferManager {
     listeners.push(updatedCallback);
   }
 
-  public dispatchEvent(event: Event & TransferEvent): boolean;
-  public dispatchEvent(event: Event & TransferCompleteEvent): boolean;
-  public dispatchEvent(event: Event): boolean;
   /**
    * Dispatches an event to the registered event listeners.
    * Triggers callbacks registered via addEventListener with matching event types.
@@ -156,6 +153,9 @@ export class S3TransferManager implements IS3TransferManager {
    *
    * @alpha
    */
+  public dispatchEvent(event: Event & TransferEvent): boolean;
+  public dispatchEvent(event: Event & TransferCompleteEvent): boolean;
+  public dispatchEvent(event: Event): boolean;
   public dispatchEvent(event: Event): boolean {
     const eventType = event.type;
     const listeners = this.eventListeners[eventType as keyof TransferEventListeners] as EventListener[];
@@ -172,6 +172,16 @@ export class S3TransferManager implements IS3TransferManager {
     return true;
   }
 
+  /**
+   * Removes a previously registered event listener from the specified event type.
+   * Stops the callback from being invoked when the event occurs.
+   *
+   * @param type - The type of event to stop listening for.
+   * @param callback - The function that was previously registered.
+   * @param options - Optional configuration for the event listener.
+   *
+   * @alpha
+   */
   public removeEventListener(
     type: "transferInitiated",
     callback: EventListener<TransferEvent>,
@@ -197,16 +207,6 @@ export class S3TransferManager implements IS3TransferManager {
     callback: EventListener,
     options?: RemoveEventListenerOptions | boolean
   ): void;
-  /**
-   * Removes a previously registered event listener from the specified event type.
-   * Stops the callback from being invoked when the event occurs.
-   *
-   * @param type - The type of event to stop listening for.
-   * @param callback - The function that was previously registered.
-   * @param options - Optional configuration for the event listener.
-   *
-   * @alpha
-   */
   public removeEventListener(
     type: string,
     callback: EventListener,
@@ -346,7 +346,7 @@ export class S3TransferManager implements IS3TransferManager {
    *
    * @param options - Configuration including bucket, source directory, filtering, failure handling, and transfer settings.
    *
-   * @returns the number of objects that have been uploaded and the number of objects that have failed
+   * @returns the number of objects that have been uploaded and the number of objects that have failed.
    *
    * @alpha
    */
@@ -371,7 +371,7 @@ export class S3TransferManager implements IS3TransferManager {
    *
    * @param options - Configuration including bucket, destination directory, filtering, failure handling, and transfer settings.
    *
-   * @returns The number of objects that have been downloaded and the number of objects that have failed
+   * @returns The number of objects that have been downloaded and the number of objects that have failed.
    *
    * @alpha
    */
@@ -728,7 +728,7 @@ export class S3TransferManager implements IS3TransferManager {
   }
 
   /**
-   * Validates configuration parameters meet minimum requirements.
+   * Validates if configuration parameters meets minimum requirements.
    *
    * @internal
    */