fix: Linter support for functions.

mathrunet · Oct 17, 2023 · d6edce6 · d6edce6
1 parent 7c785cd
commit d6edce6
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 17 deletions.
diff --git a/packages/katana_cli/lib/command/code/server/call.dart b/packages/katana_cli/lib/command/code/server/call.dart
@@ -67,30 +67,30 @@ import * as m from "@mathrunet/masamune";
     return """
 /**
  * ${className.toPascalCase()}Call
- * 
+ *
  * Create server code for FunctionCall.
  */
 export class ${className.toPascalCase()}Call extends m.CallProcessFunctionBase {
     /**
-     * @param id
+     * @param {string} id
      * Describe the method names used in Functions.
      *
      * Functionsで利用されるメソッド名を記述します。
      */
     id = "${className.toSnakeCase()}_call";
     /**
      * Specify the actual contents of the process.
-     * 
+     *
      * 実際の処理の中身を指定します。
-     * 
-     * @param query
+     *
+     * @param {any} query
      * Query passed to Functions.
-     * 
+     *
      * Functionsに渡されたクエリ。
-     * 
-     * @param options 
+     *
+     * @param {Record<string, any>} options
      * Options passed to Functions.
-     * 
+     *
      * Functionsに渡されたオプション。
      */
     async process(query: any, options: Record<string, any>): Promise<void> {

diff --git a/packages/katana_cli/lib/command/code/server/request.dart b/packages/katana_cli/lib/command/code/server/request.dart
@@ -62,12 +62,12 @@ import {Response, Request} from "firebase-functions";
     return """
 /**
  * ${className.toPascalCase()}Request
- * 
+ *
  * Create server code for HTTP requests.
  */
 export class ${className.toPascalCase()}Request extends m.RequestProcessFunctionBase {
     /**
-     * @param id
+     * @param {string} id
      * Describe the method names used in Functions.
      *
      * Functionsで利用されるメソッド名を記述します。
@@ -78,17 +78,17 @@ export class ${className.toPascalCase()}Request extends m.RequestProcessFunction
      *
      * 実際の処理の中身を指定します。
      *
-     * @param reqest
+     * @param {Request} reqest
      * Request passed to Functions.
      *
      * Functionsに渡されたRequest。
      *
-     * @param response
+     * @param {Response<any>} response
      * Response passed to Functions.
      *
      * Functionsに渡されたResponse。
      *
-     * @param options
+     * @param {Record<string, any>} options
      * Options passed to Functions.
      *
      * Functionsに渡されたオプション。

diff --git a/packages/katana_cli/lib/command/code/server/schedule.dart b/packages/katana_cli/lib/command/code/server/schedule.dart
@@ -61,18 +61,19 @@ import * as m from "@mathrunet/masamune";
     return """
 /**
  * ${className.toPascalCase()}Schedule
- * 
+ *
  * Create a server code for the scheduler.
  */
 export class ${className.toPascalCase()}Schedule extends m.ScheduleProcessFunctionBase {
     /**
-     * @param id
+     * @param {string} id
      * Describe the method names used in Functions.
      *
      * Functionsで利用されるメソッド名を記述します。
      */
     id = "${className.toSnakeCase()}_schedule";
     /**
+     * @param {string} schedule
      * Specify the schedule to execute the process in cron format.
      *
      * 処理を実行するスケジュールをcron形式で指定します。
@@ -85,7 +86,7 @@ export class ${className.toPascalCase()}Schedule extends m.ScheduleProcessFuncti
      *
      * 実際の処理の中身を指定します。
      *
-     * @param options
+     * @param {Record<string, any>} options
      * Options passed to Functions.
      *
      * Functionsに渡されたオプション。