chore(Hexo): add event emitter descriptor (#5302)

Co-authored-by: uiolee <[email protected]>

lib/hexo/index.ts

@@ -145,6 +145,88 @@ declare module 'module' {
  _cache: any;
 }
 
+interface Hexo {
+
+ /**
+ * Emitted before deployment begins.
+ * @param event
+ * @param listener
+ * @link https://hexo.io/api/events.html#deployBefore
+ */
+ on(event: 'deployBefore', listener: (...args: any[]) => any): this;
+
+ /**
+ * Emitted after deployment begins.
+ * @param event
+ * @param listener
+ * @link https://hexo.io/api/events.html#deployAfter
+ */
+ on(event: 'deployAfter', listener: (...args: any[]) => any): this;
+
+ /**
+ * Emitted before Hexo exits.
+ * @param event
+ * @param listener
+ * @link https://hexo.io/api/events.html#exit
+ */
+ on(event: 'exit', listener: (...args: any[]) => any): this;
+
+ /**
+ * Emitted before generation begins.
+ * @param event
+ * @param listener
+ * @link https://hexo.io/api/events.html#generateBefore
+ */
+ on(event: 'generateBefore', listener: (...args: any[]) => any): this;
+
+ /**
+ * Emitted after generation finishes.
+ * @param event
+ * @param listener
+ * @link https://hexo.io/api/events.html#generateAfter
+ */
+ on(event: 'generateAfter', listener: (...args: any[]) => any): this;
+
+ /**
+ * Emitted after a new post has been created. This event returns the post data:
+ * @param event
+ * @param listener
+ * @link https://hexo.io/api/events.html#new
+ */
+ on(event: 'new', listener: (post: { path: string; content: string; }) => any): this;
+
+ /**
+ * Emitted before processing begins. This event returns a path representing the root directory of the box.
+ * @param event
+ * @param listener
+ * @link https://hexo.io/api/events.html#processBefore
+ */
+ on(event: 'processBefore', listener: (...args: any[]) => any): this;
+
+ /**
+ * Emitted after processing finishes. This event returns a path representing the root directory of the box.
+ * @param event
+ * @param listener
+ * @link https://hexo.io/api/events.html#processAfter
+ */
+ on(event: 'processAfter', listener: (...args: any[]) => any): this;
+
+ /**
+ * Emitted after initialization finishes.
+ * @param event
+ * @param listener
+ */
+ on(event: 'ready', listener: (...args: any[]) => any): this;
+
+ /**
+ * undescripted on emit
+ * @param event
+ * @param listener
+ */
+ on(event: string, listener: (...args: any[]) => any): any;
+ emit(event: string, ...args: any[]): any;
+}
+
 class Hexo extends EventEmitter {
  public base_dir: string;
  public public_dir: string;