Skip to content
Snippets Groups Projects
Unverified Commit 97b99867 authored by syuilo's avatar syuilo
Browse files

Improve doc

parent a55d5516
No related branches found
No related tags found
No related merge requests found
import $ from 'cafy';
import define from '../../../define';
import perUserNotesChart from '../../../../../services/chart/per-user-notes';
import perUserNotesChart, { perUserNotesLogSchema } from '../../../../../services/chart/per-user-notes';
import ID, { transform } from '../../../../../misc/cafy-id';
import { convertLog } from '../../../../../services/chart';
export const meta = {
stability: 'stable',
......@@ -38,12 +39,7 @@ export const meta = {
}
},
res: {
type: 'array',
items: {
type: 'object',
},
},
res: convertLog(perUserNotesLogSchema),
};
export default define(meta, async (ps) => {
......
......@@ -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);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment