chore: add missing comments for documentation

Author: nicholasgriffintn

src/types.ts

@@ -1,5 +1,8 @@
 import { SQSClient, Message, QueueAttributeName } from '@aws-sdk/client-sqs';
 
+/**
+ * The options for the consumer.
+ */
 export interface ConsumerOptions {
   /**
    * The SQS queue URL.
@@ -139,12 +142,18 @@ export interface ConsumerOptions {
   postReceiveMessageCallback?(): Promise<void>;
 }
 
+/**
+ * A subset of the ConsumerOptions that can be updated at runtime.
+ */
 export type UpdatableOptions =
   | 'visibilityTimeout'
   | 'batchSize'
   | 'waitTimeSeconds'
   | 'pollingWaitTimeMs';
 
+/**
+ * The options for the stop method.
+ */
 export interface StopOptions {
   /**
    * Default to `false`, if you want the stop action to also abort requests to SQS
@@ -154,6 +163,9 @@ export interface StopOptions {
   abort?: boolean;
 }
 
+/**
+ * These are the events that the consumer emits.
+ */
 export interface Events {
   /**
    * Fired after one batch of items (up to `batchSize`) has been successfully processed.
@@ -212,6 +224,9 @@ export interface Events {
   waiting_for_polling_to_complete_timeout_exceeded: [];
 }
 
+/**
+ * The error object that is emitted with error events from AWS.
+ */
 export type AWSError = {
   /**
    * Name, eg. ConditionalCheckFailedException