From 97b99867f22ef03b3759e5e78ef3ce1e78d83f17 Mon Sep 17 00:00:00 2001
From: syuilo <syuilotan@yahoo.co.jp>
Date: Sun, 24 Feb 2019 10:04:27 +0900
Subject: Improve doc

---
 src/services/chart/per-user-notes.ts | 76 +++++++++++++++++++-----------------
 1 file changed, 41 insertions(+), 35 deletions(-)

(limited to 'src/services/chart')

diff --git a/src/services/chart/per-user-notes.ts b/src/services/chart/per-user-notes.ts
index 9ce4e67c50..957a85737d 100644
--- a/src/services/chart/per-user-notes.ts
+++ b/src/services/chart/per-user-notes.ts
@@ -2,44 +2,50 @@ import autobind from 'autobind-decorator';
 import Chart, { Obj } from './';
 import Note, { INote } from '../../models/note';
 import { IUser } from '../../models/user';
+import { SchemaType } from '../../prelude/schema';
 
-/**
- * ユーザーごとの投稿に関するチャート
- */
-type PerUserNotesLog = {
-	/**
-	 * 集計期間時点での、全投稿数
-	 */
-	total: number;
-
-	/**
-	 * 増加した投稿数
-	 */
-	inc: number;
-
-	/**
-	 * 減少した投稿数
-	 */
-	dec: number;
-
-	diffs: {
-		/**
-		 * 通常の投稿数の差分
-		 */
-		normal: number;
-
-		/**
-		 * リプライの投稿数の差分
-		 */
-		reply: number;
-
-		/**
-		 * Renoteの投稿数の差分
-		 */
-		renote: number;
-	};
+export const perUserNotesLogSchema = {
+	type: 'object' as 'object',
+	properties: {
+		total: {
+			type: 'number' as 'number',
+			description: '集計期間時点での、全投稿数'
+		},
+
+		inc: {
+			type: 'number' as 'number',
+			description: '増加した投稿数'
+		},
+
+		dec: {
+			type: 'number' as 'number',
+			description: '減少した投稿数'
+		},
+
+		diffs: {
+			type: 'object' as 'object',
+			properties: {
+				normal: {
+					type: 'number' as 'number',
+					description: '通常の投稿数の差分'
+				},
+
+				reply: {
+					type: 'number' as 'number',
+					description: 'リプライの投稿数の差分'
+				},
+
+				renote: {
+					type: 'number' as 'number',
+					description: 'Renoteの投稿数の差分'
+				},
+			}
+		},
+	}
 };
 
+type PerUserNotesLog = SchemaType<typeof perUserNotesLogSchema>;
+
 class PerUserNotesChart extends Chart<PerUserNotesLog> {
 	constructor() {
 		super('perUserNotes', true);
-- 
cgit v1.2.3-freya