fix(todo): JSDocのdestructuringの記法を修正

azu · azu · commit 06776ba1a591 · 2018-12-30T15:25:49.000+09:00
この書籍の主題ではないので、できるだけコンパクトな方法を採用 - microsoft/TypeScript#24045 - google/closure-compiler#1781 - microsoft/TypeScript#24746 fix #606
diff --git a/source/use-case/todoapp/event-model/event-emitter/src/view/html-util.js b/source/use-case/todoapp/event-model/event-emitter/src/view/html-util.js
@@ -15,7 +15,7 @@ export function htmlToElement(html) {
 
 /**
  * HTML文字列からDOM Nodeを作成して返す
- * @return {HTMLElement}
+ * @return {Element}
  */
 export function element(strings, ...values) {
     const htmlString = strings.reduce((result, string, i) => {
@@ -31,8 +31,8 @@ export function element(strings, ...values) {
 
 /**
  * コンテナ要素の中身をbodyElementで上書きする
- * @param {HTMLElement} bodyElement コンテナ要素の中身となる要素
- * @param {HTMLElement} containerElement コンテナ要素
+ * @param {Element} bodyElement コンテナ要素の中身となる要素
+ * @param {Element} containerElement コンテナ要素
  */
 export function render(bodyElement, containerElement) {
     // rootElementの中身を空にする
diff --git a/source/use-case/todoapp/final/create-view/src/model/TodoItemModel.js b/source/use-case/todoapp/final/create-view/src/model/TodoItemModel.js
@@ -3,8 +3,9 @@ let todoIdx = 0;
 
 export class TodoItemModel {
     /**
-     * @param {string} title Todoアイテムのタイトル
-     * @param {boolean} completed Todoアイテムが完了済みならばtrue、そうでない場合はfalse
+     * `title`: Todoアイテムのタイトル
+     * `completed`: Todoアイテムが完了済みならばtrue、そうでない場合はfalse
+     * @param {{ title: string, completed: boolean }}
      */
     constructor({ title, completed }) {
         // idは自動的に連番となりそれぞれのインスタンス毎に異なるものとする
diff --git a/source/use-case/todoapp/final/create-view/src/model/TodoListModel.js b/source/use-case/todoapp/final/create-view/src/model/TodoListModel.js
@@ -55,8 +55,7 @@ export class TodoListModel extends EventEmitter {
 
     /**
      * 指定したidのTodoItemのcompletedを更新する
-     * @param {number} id
-     * @param {boolean} completed
+     * @param {{ id:number, completed: boolean }}
      */
     updateTodo({ id, completed }) {
         const todoItem = this.items.find(todo => todo.id === id);
@@ -69,7 +68,7 @@ export class TodoListModel extends EventEmitter {
 
     /**
      * 指定したidのTodoItemを削除する
-     * @param {number} id
+     * @param {{ id: number }}
      */
     deleteTodo({ id }) {
         // `id`が一致するTodoItemを`this.items`から取り除き、削除する
diff --git a/source/use-case/todoapp/final/create-view/src/view/TodoItemView.js b/source/use-case/todoapp/final/create-view/src/view/TodoItemView.js
@@ -6,7 +6,7 @@ export class TodoItemView {
      * @param {TodoItemModel} todoItem
      * @param {function({id:string, completed: boolean})} onUpdateTodo チェックボックスの更新イベントリスナー
      * @param {function({id:string)}} onDeleteTodo 削除ボタンのクリックイベントリスナー
-     * @returns {HTMLElement}
+     * @returns {Element}
      */
     createElement(todoItem, { onUpdateTodo, onDeleteTodo }) {
         const todoItemElement = todoItem.completed
diff --git a/source/use-case/todoapp/final/create-view/src/view/TodoListView.js b/source/use-case/todoapp/final/create-view/src/view/TodoListView.js
@@ -7,7 +7,7 @@ export class TodoListView {
      * @param {TodoItemModel[]} todoItems TodoItemModelの配列
      * @param {function({id:string, completed: boolean})} onUpdateTodo チェックボックスの更新イベントリスナー
      * @param {function({id:string)}} onDeleteTodo 削除ボタンのクリックイベントリスナー
-     * @returns {HTMLElement} TodoItemModelの配列に対応したリストのHTML要素
+     * @returns {Element} TodoItemModelの配列に対応したリストのHTML要素
      */
     createElement(todoItems, { onUpdateTodo, onDeleteTodo }) {
         const todoListElement = element`<ul />`;
diff --git a/source/use-case/todoapp/final/create-view/src/view/html-util.js b/source/use-case/todoapp/final/create-view/src/view/html-util.js
@@ -15,7 +15,7 @@ export function htmlToElement(html) {
 
 /**
  * HTML文字列からDOM Nodeを作成して返す
- * @return {HTMLElement}
+ * @return {Element}
  */
 export function element(strings, ...values) {
     const htmlString = strings.reduce((result, string, i) => {
@@ -31,8 +31,8 @@ export function element(strings, ...values) {
 
 /**
  * コンテナ要素の中身をbodyElementで上書きする
- * @param {HTMLElement} bodyElement コンテナ要素の中身となる要素
- * @param {HTMLElement} containerElement コンテナ要素
+ * @param {Element} bodyElement コンテナ要素の中身となる要素
+ * @param {Element} containerElement コンテナ要素
  */
 export function render(bodyElement, containerElement) {
     // rootElementの中身を空にする
diff --git a/source/use-case/todoapp/final/final/src/App.js b/source/use-case/todoapp/final/final/src/App.js
@@ -19,16 +19,15 @@ export class App {
 
     /**
      * Todoの状態を更新時に呼ばれるリスナー関数
-     * @param {number} id
-     * @param {boolean} completed
+     * @param {{ id:number, completed: boolean }}
      */
     handleUpdate({ id, completed }) {
         this.todoListModel.updateTodo({ id, completed });
     };
 
     /**
      * Todoを削除時に呼ばれるリスナー関数
-     * @param {number} id
+     * @param {{ id: number }}
      */
     handleDelete({ id }) {
         this.todoListModel.deleteTodo({ id });
@@ -56,10 +55,7 @@ export class App {
 
         formElement.addEventListener("submit", (event) => {
             event.preventDefault();
-            this.todoListModel.addTodo(new TodoItemModel({
-                title: inputElement.value,
-                completed: false
-            }));
+            this.handleAdd(inputElement.value);
             inputElement.value = "";
         });
     }
diff --git a/source/use-case/todoapp/final/final/src/model/TodoItemModel.js b/source/use-case/todoapp/final/final/src/model/TodoItemModel.js
@@ -3,8 +3,9 @@ let todoIdx = 0;
 
 export class TodoItemModel {
     /**
-     * @param {string} title Todoアイテムのタイトル
-     * @param {boolean} completed Todoアイテムが完了済みならばtrue、そうでない場合はfalse
+     * `title`: Todoアイテムのタイトル
+     * `completed`: Todoアイテムが完了済みならばtrue、そうでない場合はfalse
+     * @param {{ title: string, completed: boolean }}
      */
     constructor({ title, completed }) {
         // idは自動的に連番となりそれぞれのインスタンス毎に異なるものとする
diff --git a/source/use-case/todoapp/final/final/src/model/TodoListModel.js b/source/use-case/todoapp/final/final/src/model/TodoListModel.js
@@ -55,8 +55,7 @@ export class TodoListModel extends EventEmitter {
 
     /**
      * 指定したidのTodoItemのcompletedを更新する
-     * @param {number} id
-     * @param {boolean} completed
+     * @param {{ id:number, completed: boolean }}
      */
     updateTodo({ id, completed }) {
         const todoItem = this.items.find(todo => todo.id === id);
@@ -69,7 +68,7 @@ export class TodoListModel extends EventEmitter {
 
     /**
      * 指定したidのTodoItemを削除する
-     * @param {number} id
+     * @param {{ id: number }}
      */
     deleteTodo({ id }) {
         // `id`が一致するTodoItemを`this.items`から取り除き、削除する
diff --git a/source/use-case/todoapp/final/final/src/view/TodoItemView.js b/source/use-case/todoapp/final/final/src/view/TodoItemView.js
@@ -6,7 +6,7 @@ export class TodoItemView {
      * @param {TodoItemModel} todoItem
      * @param {function({id:string, completed: boolean})} onUpdateTodo チェックボックスの更新イベントリスナー
      * @param {function({id:string)}} onDeleteTodo 削除ボタンのクリックイベントリスナー
-     * @returns {HTMLElement}
+     * @returns {Element}
      */
     createElement(todoItem, { onUpdateTodo, onDeleteTodo }) {
         const todoItemElement = todoItem.completed
diff --git a/source/use-case/todoapp/final/final/src/view/TodoListView.js b/source/use-case/todoapp/final/final/src/view/TodoListView.js
@@ -7,7 +7,7 @@ export class TodoListView {
      * @param {TodoItemModel[]} todoItems TodoItemModelの配列
      * @param {function({id:string, completed: boolean})} onUpdateTodo チェックボックスの更新イベントリスナー
      * @param {function({id:string)}} onDeleteTodo 削除ボタンのクリックイベントリスナー
-     * @returns {HTMLElement} TodoItemModelの配列に対応したリストのHTML要素
+     * @returns {Element} TodoItemModelの配列に対応したリストのHTML要素
      */
     createElement(todoItems, { onUpdateTodo, onDeleteTodo }) {
         const todoListElement = element`<ul />`;
diff --git a/source/use-case/todoapp/final/final/src/view/html-util.js b/source/use-case/todoapp/final/final/src/view/html-util.js
@@ -15,7 +15,7 @@ export function htmlToElement(html) {
 
 /**
  * HTML文字列からDOM Nodeを作成して返す
- * @return {HTMLElement}
+ * @return {Element}
  */
 export function element(strings, ...values) {
     const htmlString = strings.reduce((result, string, i) => {
@@ -31,8 +31,8 @@ export function element(strings, ...values) {
 
 /**
  * コンテナ要素の中身をbodyElementで上書きする
- * @param {HTMLElement} bodyElement コンテナ要素の中身となる要素
- * @param {HTMLElement} containerElement コンテナ要素
+ * @param {Element} bodyElement コンテナ要素の中身となる要素
+ * @param {Element} containerElement コンテナ要素
  */
 export function render(bodyElement, containerElement) {
     // rootElementの中身を空にする
diff --git a/source/use-case/todoapp/form-event/add-todo-item/src/view/html-util.js b/source/use-case/todoapp/form-event/add-todo-item/src/view/html-util.js
@@ -15,7 +15,7 @@ export function htmlToElement(html) {
 
 /**
  * HTML文字列からDOM Nodeを作成して返す
- * @return {HTMLElement}
+ * @return {Element}
  */
 export function element(strings, ...values) {
     const htmlString = strings.reduce((result, string, i) => {
@@ -31,8 +31,8 @@ export function element(strings, ...values) {
 
 /**
  * コンテナ要素の中身をbodyElementで上書きする
- * @param {HTMLElement} bodyElement コンテナ要素の中身となる要素
- * @param {HTMLElement} containerElement コンテナ要素
+ * @param {Element} bodyElement コンテナ要素の中身となる要素
+ * @param {Element} containerElement コンテナ要素
  */
 export function render(bodyElement, containerElement) {
     // rootElementの中身を空にする
diff --git a/source/use-case/todoapp/update-delete/add-checkbox/src/model/TodoItemModel.js b/source/use-case/todoapp/update-delete/add-checkbox/src/model/TodoItemModel.js
@@ -3,8 +3,9 @@ let todoIdx = 0;
 
 export class TodoItemModel {
     /**
-     * @param {string} title Todoアイテムのタイトル
-     * @param {boolean} completed Todoアイテムが完了済みならばtrue、そうでない場合はfalse
+     * `title`: Todoアイテムのタイトル
+     * `completed`: Todoアイテムが完了済みならばtrue、そうでない場合はfalse
+     * @param {{ title: string, completed: boolean }}
      */
     constructor({ title, completed }) {
         // idは自動的に連番となりそれぞれのインスタンス毎に異なるものとする
diff --git a/source/use-case/todoapp/update-delete/add-checkbox/src/view/html-util.js b/source/use-case/todoapp/update-delete/add-checkbox/src/view/html-util.js
@@ -15,7 +15,7 @@ export function htmlToElement(html) {
 
 /**
  * HTML文字列からDOM Nodeを作成して返す
- * @return {HTMLElement}
+ * @return {Element}
  */
 export function element(strings, ...values) {
     const htmlString = strings.reduce((result, string, i) => {
@@ -31,8 +31,8 @@ export function element(strings, ...values) {
 
 /**
  * コンテナ要素の中身をbodyElementで上書きする
- * @param {HTMLElement} bodyElement コンテナ要素の中身となる要素
- * @param {HTMLElement} containerElement コンテナ要素
+ * @param {Element} bodyElement コンテナ要素の中身となる要素
+ * @param {Element} containerElement コンテナ要素
  */
 export function render(bodyElement, containerElement) {
     // rootElementの中身を空にする
diff --git a/source/use-case/todoapp/update-delete/delete-feature/src/model/TodoListModel.js b/source/use-case/todoapp/update-delete/delete-feature/src/model/TodoListModel.js
@@ -54,9 +54,8 @@ export class TodoListModel extends EventEmitter {
     }
 
     /**
-     * 指定したidのTodoItemのcompletedを更新する
-     * @param {number} id
-     * @param {boolean} completed
+     * 指定した`id`のTodoItemの`completed`を更新する
+     * @param {{ id:number, completed: boolean }}
      */
     updateTodo({ id, completed }) {
         const todoItem = this.items.find(todo => todo.id === id);
@@ -73,7 +72,7 @@ export class TodoListModel extends EventEmitter {
     // ===============================
     /**
      * 指定したidのTodoItemを削除する
-     * @param {number} id
+     * @param {{ id: number }}
      */
     deleteTodo({ id }) {
         // `id`が一致するTodoItemを`this.items`から取り除き、削除する
diff --git a/source/use-case/todoapp/update-delete/delete-feature/src/view/html-util.js b/source/use-case/todoapp/update-delete/delete-feature/src/view/html-util.js
@@ -15,7 +15,7 @@ export function htmlToElement(html) {
 
 /**
  * HTML文字列からDOM Nodeを作成して返す
- * @return {HTMLElement}
+ * @return {Element}
  */
 export function element(strings, ...values) {
     const htmlString = strings.reduce((result, string, i) => {
@@ -31,8 +31,8 @@ export function element(strings, ...values) {
 
 /**
  * コンテナ要素の中身をbodyElementで上書きする
- * @param {HTMLElement} bodyElement コンテナ要素の中身となる要素
- * @param {HTMLElement} containerElement コンテナ要素
+ * @param {Element} bodyElement コンテナ要素の中身となる要素
+ * @param {Element} containerElement コンテナ要素
  */
 export function render(bodyElement, containerElement) {
     // rootElementの中身を空にする
diff --git a/source/use-case/todoapp/update-delete/update-feature/src/model/TodoItemModel.js b/source/use-case/todoapp/update-delete/update-feature/src/model/TodoItemModel.js
@@ -3,8 +3,9 @@ let todoIdx = 0;
 
 export class TodoItemModel {
     /**
-     * @param {string} title Todoアイテムのタイトル
-     * @param {boolean} completed Todoアイテムが完了済みならばtrue、そうでない場合はfalse
+     * `title`: Todoアイテムのタイトル
+     * `completed`: Todoアイテムが完了済みならばtrue、そうでない場合はfalse
+     * @param {{ title: string, completed: boolean }}
      */
     constructor({ title, completed }) {
         // idは自動的に連番となりそれぞれのインスタンス毎に異なるものとする
diff --git a/source/use-case/todoapp/update-delete/update-feature/src/model/TodoListModel.js b/source/use-case/todoapp/update-delete/update-feature/src/model/TodoListModel.js
@@ -58,8 +58,7 @@ export class TodoListModel extends EventEmitter {
     // ===============================
     /**
      * 指定したidのTodoItemのcompletedを更新する
-     * @param {number} id
-     * @param {boolean} completed
+     * @param {{ id:number, completed: boolean }}
      */
     updateTodo({ id, completed }) {
         // `id`が一致するTodoItemを見つけ、あるなら完了状態の値を更新する
diff --git a/source/use-case/todoapp/update-delete/update-feature/src/view/html-util.js b/source/use-case/todoapp/update-delete/update-feature/src/view/html-util.js
@@ -15,7 +15,7 @@ export function htmlToElement(html) {
 
 /**
  * HTML文字列からDOM Nodeを作成して返す
- * @return {HTMLElement}
+ * @return {Element}
  */
 export function element(strings, ...values) {
     const htmlString = strings.reduce((result, string, i) => {
@@ -31,8 +31,8 @@ export function element(strings, ...values) {
 
 /**
  * コンテナ要素の中身をbodyElementで上書きする
- * @param {HTMLElement} bodyElement コンテナ要素の中身となる要素
- * @param {HTMLElement} containerElement コンテナ要素
+ * @param {Element} bodyElement コンテナ要素の中身となる要素
+ * @param {Element} containerElement コンテナ要素
  */
 export function render(bodyElement, containerElement) {
     // rootElementの中身を空にする
