@lopan/filterchain 1.0.0 → 1.0.1

package/FilterChain.ts

@@ -15,8 +15,8 @@ import type IResource from './IResource.ts';
  * <-- res -- |         | <-- res -- |         | <-- res -- |
  * ```
  */
-export default class FilterChain implements IFilterChain {
-    private resource: IResource | null = null;
+export default class FilterChain<T> implements IFilterChain<T> {
+    private resource: IResource<T> | null = null;
 
     /**
      * The current position of the filter chain
@@ -26,12 +26,12 @@ export default class FilterChain implements IFilterChain {
     /**
      * The filter collection
      */
-    private filters: IFilter[] = [];
+    private filters: IFilter<T>[] = [];
 
     /**
      * @inheritdoc
      */
-    public async doFilter(payload: unknown): Promise<unknown> {
+    public async doFilter(payload: T): Promise<unknown> {
         if (this.position >= this.filters.length) {
             const resource = this.resource;
             this.clearFilters();
@@ -51,7 +51,7 @@ export default class FilterChain implements IFilterChain {
     /**
      * Add a filter to the filter chain
      */
-    public addFilter(filter: IFilter): void {
+    public addFilter(filter: IFilter<T>): void {
         this.filters.push(filter);
     }
 
@@ -67,7 +67,7 @@ export default class FilterChain implements IFilterChain {
     /**
      * Set the resource
      */
-    public setResource(resource: IResource | null): void {
+    public setResource(resource: IResource<T> | null): void {
         this.resource = resource;
     }
 }

package/IFilter.ts

@@ -9,11 +9,11 @@ import type IFilterChain from './IFilterChain.ts';
  *
  * The class that implements the `doFilter` method considers to be a filter
  */
-export default interface IFilter {
+export default interface IFilter<T> {
     /**
      * The filter method
      *
      * This method needs to call `filterChain.doFilter(payload)` manually to execute the next filter
      */
-    doFilter(payload: unknown, filterChain: IFilterChain): Promise<unknown>;
+    doFilter(payload: T, filterChain: IFilterChain<T>): Promise<unknown>;
 }

package/IFilterChain.ts

@@ -6,9 +6,9 @@
 /**
  * Filter chain interface
  */
-export default interface IFilterChain {
+export default interface IFilterChain<T> {
     /**
      * Invoked the next filter or the resource
      */
-    doFilter(payload: unknown): Promise<unknown>;
+    doFilter(payload: T): Promise<unknown>;
 }

package/IResource.ts

@@ -6,9 +6,9 @@
 /**
  * Class implementing this interface is a resource class
  */
-export default interface IResource {
+export default interface IResource<T> {
     /**
      * Run the resource
      */
-    run(payload: unknown): Promise<unknown>;
+    run(payload: T): Promise<unknown>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lopan/filterchain",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "FilterChain.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/test/index.ts

@@ -1,28 +1,32 @@
 import FilterChain from '../FilterChain.ts';
 import type IFilter from '../IFilter.ts';
+import IFilterChain from '../IFilterChain.ts';
 
+type FilterData = {
+  data: string
+} | null
 
-class ImgFilter1 implements IFilter {
-    public async doFilter(payload: unknown, filterChain: FilterChain): Promise<unknown> {
-        console.log('ImgFilter1 before');
-        const res = await filterChain.doFilter(payload);
-        console.log('ImgFilter1 after');
-        return res;
-    }
-}
-class ImgFilter2 implements IFilter {
-    public async doFilter(payload: unknown, filterChain: FilterChain): Promise<unknown> {
-        console.log('ImgFilter2 before');
-        const res = await filterChain.doFilter(payload);
-        console.log('ImgFilter2 after');
-        return res;
-    }
+class ImgFilter1 implements IFilter<FilterData> {
+  async doFilter(payload: FilterData, filterChain: IFilterChain<FilterData>): Promise<unknown> {
+    console.log('ImgFilter1 before');
+    const res = await filterChain.doFilter(payload);
+    console.log('ImgFilter1 after');
+    return res;
+  }
 }
 
+class ImgFilter2 implements IFilter<FilterData> {
+  async doFilter(payload: FilterData, filterChain: IFilterChain<FilterData>): Promise<unknown> {
+    console.log('ImgFilter2 before');
+    const res = await filterChain.doFilter(payload);
+    console.log('ImgFilter2 after');
+    return res;
+  }
+}
 
 class Main {
   static async run() {
-    const chain = new FilterChain()
+    const chain = new FilterChain<FilterData>()
     // chain.setResource(null)
     chain.addFilter(new ImgFilter1())
     chain.addFilter(new ImgFilter2())
@@ -32,4 +36,4 @@ class Main {
   }
 }
 
-Main.run()
+Main.run()