reafactor: better function type

hexojs · Mar 27, 2023 · 4c99a3d · 4c99a3d
1 parent 5ae2313
commit 4c99a3d
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 9 deletions.
diff --git a/lib/extend/console.ts b/lib/extend/console.ts
@@ -15,7 +15,11 @@ type Option = Partial<{
   }[];
 }>
 
-type AnyFn = (args: any[]) => any;
+interface Args {
+  _: string[];
+  [key: string]: string | boolean | string[];
+}
+type AnyFn = (args: Args) => any;
 interface StoreFunction extends AnyFn {
   desc?: string;
   options?: Option;

diff --git a/lib/extend/filter.ts b/lib/extend/filter.ts
@@ -12,7 +12,7 @@ interface FilterOptions {
 }
 
 interface StoreFunction {
-  (...args: any[]): any;
+  (data?: any, ...args: any[]): any;
   priority?: number;
 }
 

diff --git a/lib/extend/generator.ts b/lib/extend/generator.ts
@@ -1,7 +1,21 @@
 import Promise from 'bluebird';
 
+interface BaseObj {
+  path: string;
+  data: any;
+  layout?: string;
+}
+type ReturnType = BaseObj | BaseObj[];
+type GeneratorReturnType = ReturnType | Promise<ReturnType>;
+
+interface GeneratorFunction {
+  (locals: object): GeneratorReturnType;
+}
+
+type StoreFunctionReturn = Promise<ReturnType>;
+
 interface StoreFunction {
-  (...args: any[]): any;
+  (locals: object): StoreFunctionReturn;
 }
 
 interface Store {
@@ -25,9 +39,9 @@ class Generator {
     return this.store[name];
   }
 
-  register(fn: StoreFunction): void
-  register(name: string, fn: StoreFunction): void
-  register(name: string | StoreFunction, fn?: StoreFunction) {
+  register(fn: GeneratorFunction): void
+  register(name: string, fn: GeneratorFunction): void
+  register(name: string | GeneratorFunction, fn?: GeneratorFunction) {
     if (!fn) {
       if (typeof name === 'function') { // fn
         fn = name;

diff --git a/lib/extend/helper.ts b/lib/extend/helper.ts
@@ -1,5 +1,5 @@
 interface StoreFunction {
-  (...args: any[]): any;
+  (...args: any[]): string;
 }
 
 interface Store {

diff --git a/lib/extend/processor.ts b/lib/extend/processor.ts
@@ -1,8 +1,9 @@
 import Promise from 'bluebird';
 import { Pattern } from 'hexo-util';
+import File from '../box/file';
 
 interface StoreFunction {
-  (args: any): any
+  (file: File): any
 }
 
 type Store = {
@@ -41,7 +42,7 @@ class Processor {
     }
 
     this.store.push({
-      pattern: new Pattern(pattern),
+      pattern: new Pattern(pattern as patternType),
       process: fn
     });
   }