Feat: Add .done getter on paginators

Author: alkihis

doc/paginators.md

@@ -21,6 +21,16 @@ for (const fetchedTweet of homeTimeline) {
 }
 ```
 
+## Check if a next page is available
+
+You can know if a paginator is over by looking up the `.done` property.
+
+```ts
+while (!homeTimeline.done) {
+  await homeTimeline.fetchNext();
+}
+```
+
 ## Download next page
 
 You can fetch the next page of the collection with the method `.fetchNext()`.

src/paginators/TwitterPaginator.ts

@@ -145,6 +145,10 @@ export abstract class TwitterPaginator<TApiResult, TApiParams extends object, TI
     return this._realData;
   }
 
+  get done() {
+    return !this.canFetchNextPage(this._realData);
+  }
+
   /**
    * Iterate over currently fetched items.
    */