mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-19 01:35:18 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

NoteAuthorshipDto: Add doc comments

Browse source 
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-01-25 22:44:47 +01:00
parent 84143eec7d
commit be2dc0e4d6
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/notes/note-authorship.dto.ts
View file

@ -8,16 +8,41 @@ import { IsDate, IsNumber, IsString, Min } from 'class-validator';
import { UserInfoDto } from '../users/user-info.dto'; import { UserInfoDto } from '../users/user-info.dto';
export class NoteAuthorshipDto { export class NoteAuthorshipDto {
/**
* Username of the user who authored this section
* @example "john.smith"
*/
@IsString() @IsString()
userName: UserInfoDto['userName']; userName: UserInfoDto['userName'];
/**
* Character index of the start of this section
* @example 102
*/
@IsNumber() @IsNumber()
@Min(0) @Min(0)
startPos: number; startPos: number;
/**
* Character index of the end of this section
* Must be greater than {@link startPos}
* @example 154
*/
@IsNumber() @IsNumber()
@Min(0) @Min(0)
endPos: number; endPos: number;
/**
* Datestring of the time this section was created
* @example "2020-12-01 12:23:34"
*/
@IsDate() @IsDate()
createdAt: Date; createdAt: Date;
/**
* Datestring of the last time this section was edited
* @example "2020-12-01 12:23:34"
*/
@IsDate() @IsDate()
updatedAt: Date; updatedAt: Date;
} }