mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-23 02:06:29 -05:00
RevisionMetadataDto: Add doc comments
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
parent
43194500e9
commit
84143eec7d
1 changed files with 12 additions and 0 deletions
|
@ -8,12 +8,24 @@ import { IsDate, IsNumber } from 'class-validator';
|
|||
import { Revision } from './revision.entity';
|
||||
|
||||
export class RevisionMetadataDto {
|
||||
/**
|
||||
* ID of this revision
|
||||
* @example 13
|
||||
*/
|
||||
@IsNumber()
|
||||
id: Revision['id'];
|
||||
|
||||
/**
|
||||
* Datestring of the time this revision was created
|
||||
* @example "2020-12-01 12:23:34"
|
||||
*/
|
||||
@IsDate()
|
||||
createdAt: Date;
|
||||
|
||||
/**
|
||||
* Number of characters in this revision
|
||||
* @example 142
|
||||
*/
|
||||
@IsNumber()
|
||||
length: number;
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue