replace state in plugin events with this

Author: ScriptSmith

plugins/plugin.ts

@@ -5,21 +5,21 @@ import {TFullApiPost, TPost, TSearchResult, TSinglePost} from "..";
 export type DType = TPost | TSinglePost | TFullApiPost | TSearchResult;
 
 export interface IPlugin {
-    constructionEvent?(state: instamancer.Instagram<DType>): void;
+    constructionEvent?(this: instamancer.Instagram<DType>): void;
 
     requestEvent?(
+        this: instamancer.Instagram<DType>,
         req: puppeteer.Request,
         overrides: puppeteer.Overrides,
-        state: instamancer.Instagram<DType>,
     ): void;
 
     responseEvent?(
+        this: instamancer.Instagram<DType>,
         res: puppeteer.Response,
         data: DType,
-        state: instamancer.Instagram<DType>,
     ): void;
 
-    postPageEvent?(data: DType, state: instamancer.Instagram<DType>): void;
+    postPageEvent?(this: instamancer.Instagram<DType>, data: DType): void;
 
-    graftingEvent?(state: instamancer.Instagram<DType>): void;
+    graftingEvent?(this: instamancer.Instagram<DType>): void;
 }

plugins/plugins/largeFirst.ts

@@ -5,15 +5,11 @@ import {Instagram} from "../../src/api/instagram";
 import {DType, IPlugin} from "../plugin";
 
 export class LargeFirst implements IPlugin {
-    public constructionEvent(state: Instagram<DType>): void {
-        state.jumpSize = 150;
+    public constructionEvent(this: Instagram<DType>): void {
+        this.jumpSize = 150;
     }
 
-    public requestEvent(
-        req: Request,
-        overrides: Overrides,
-        state: Instagram<DType>,
-    ): void {
+    public requestEvent(req: Request, overrides: Overrides): void {
         const url = overrides["url"] ? overrides["url"] : req.url();
         const parsedUrl = urlParse(url);
         const query = querystring.parse(parsedUrl.query);

src/api/instagram.ts

@@ -16,7 +16,7 @@ import {
     Response,
 } from "puppeteer";
 import * as winston from "winston";
-import {IPlugin} from "../../plugins/plugin";
+import {IPlugin} from "../../plugins";
 import {IOptions} from "./api";
 import {PostIdSet} from "./postIdSet";
 
@@ -192,7 +192,7 @@ export class Instagram<PostType> extends EventEmitter {
         this.validator = options.validator || validator;
 
         this.addPlugins(options.plugins);
-        this.emit("construction", this);
+        this.emit("construction");
     }
 
     /**
@@ -348,7 +348,7 @@ export class Instagram<PostType> extends EventEmitter {
                         headers: this.graftHeaders,
                         url: this.graftURL,
                     };
-                    this.emit("request", req, overrides, this);
+                    this.emit("request", req, overrides);
                     await req.continue(overrides);
 
                     // Reset grafting data
@@ -362,7 +362,7 @@ export class Instagram<PostType> extends EventEmitter {
                 break;
             } else {
                 const overrides = {};
-                this.emit("request", req, overrides, this);
+                this.emit("request", req, overrides);
                 await req.continue(overrides);
             }
         }
@@ -400,7 +400,7 @@ export class Instagram<PostType> extends EventEmitter {
             }
 
             // Emit event
-            this.emit("response", res, data, this);
+            this.emit("response", res, data);
 
             // Check for rate limiting
             if (data && "status" in data && data["status"] === "fail") {
@@ -516,7 +516,7 @@ export class Instagram<PostType> extends EventEmitter {
         if (!parsed) {
             return;
         }
-        this.emit("postPage", parsed, this);
+        this.emit("postPage", parsed);
         await this.addToPostBuffer(parsed);
     }
 
@@ -821,7 +821,7 @@ export class Instagram<PostType> extends EventEmitter {
 
         await this.progress(Progress.GRAFTING);
 
-        this.emit("grafting", this);
+        this.emit("grafting");
 
         // Enable grafting
         this.graft = true;

tests/test.spec.ts

@@ -533,12 +533,12 @@ describe("Search", () => {
         const searchRequestsSpy = jest.fn();
         class RequestCounter implements IPlugin {
             public requestEvent(
+                this: Instagram<DType>,
                 req: Request,
                 overrides: Overrides,
-                state: Instagram<DType>,
             ): void {
                 // @ts-ignore
-                if (state.matchURL(req.url())) {
+                if (this.matchURL(req.url())) {
                     searchRequestsSpy();
                 }
             }