@open-sauced/api documentation
  1. Classes
  2. HighlightOptionsDto

File

src/highlight/dtos/highlight-options.dto.ts

Extends

PageOptionsDto

Index

Properties

Properties

Readonly Optional contributor
Type : string
Decorators :
@ApiPropertyOptional({description: 'Highlight User Filter', example: 'RitaDee'})
@IsString()
@IsOptional()
Defined in src/highlight/dtos/highlight-options.dto.ts:21
Readonly Optional repo
Type : string
Decorators :
@ApiPropertyOptional({description: 'Highlight Repo Filter', example: 'open-sauced/insights'})
@IsString()
@IsOptional()
Defined in src/highlight/dtos/highlight-options.dto.ts:13
Readonly Optional limit
Type : number
Default value : 50
Decorators :
@ApiPropertyOptional({minimum: 1, maximum: 1000, default: 10, type: 'integer'})
@Type(undefined)
@IsInt()
@Min(1)
@Max(10000)
@IsOptional()
Inherited from PageOptionsDto
Defined in PageOptionsDto:30
Readonly Optional orderDirection
Type : OrderDirectionEnum
Default value : OrderDirectionEnum.DESC
Decorators :
@ApiPropertyOptional({enum: OrderDirectionEnum, enumName: 'OrderDirectionEnum', default: undefined})
@IsEnum(OrderDirectionEnum)
@IsOptional()
Inherited from PageOptionsDto
Defined in PageOptionsDto:35
Readonly Optional page
Type : number
Default value : 1
Decorators :
@ApiPropertyOptional({minimum: 1, default: 1, type: 'integer'})
@Type(undefined)
@IsInt()
@Min(1)
@IsOptional()
Inherited from PageOptionsDto
Defined in PageOptionsDto:17
Readonly Optional prev_days_start_date
Type : number
Default value : 0
Decorators :
@ApiPropertyOptional({description: 'Number of days in the past to start range block', default: 0, type: 'integer'})
@Type(undefined)
@IsIn(['0', '7', '30', '90', '180'])
@IsInt()
@IsOptional()
Inherited from PageOptionsDto
Defined in PageOptionsDto:57
Readonly Optional range
Type : number
Default value : 30
Decorators :
@ApiPropertyOptional({description: 'Range in days', default: 30, type: 'integer'})
@Type(undefined)
@IsIn(['7', '30', '90', '180', '360'])
@IsInt()
@IsOptional()
Inherited from PageOptionsDto
Defined in PageOptionsDto:46 
import { ApiPropertyOptional, PickType } from "@nestjs/swagger";
import { IsOptional, IsString } from "class-validator";
import { PageOptionsDto } from "../../common/dtos/page-options.dto";
import { DbUserHighlightReaction } from "../../user/entities/user-highlight-reaction.entity";

export class HighlightOptionsDto extends PageOptionsDto {
  @ApiPropertyOptional({
    description: "Highlight Repo Filter",
    example: "open-sauced/insights",
  })
  @IsString()
  @IsOptional()
  readonly repo?: string;

  @ApiPropertyOptional({
    description: "Highlight User Filter",
    example: "RitaDee",
  })
  @IsString()
  @IsOptional()
  readonly contributor?: string;
}

export class DbUserHighlightReactionResponse extends PickType(DbUserHighlightReaction, ["emoji_id", "reaction_count"]) {
  @ApiPropertyOptional({
    description: "Usernames of users who reacted with this emoji",
    type: "string",
    example: ["RitaDee", "diivi"],
    isArray: true,
  })
  @IsString({ each: true })
  @IsOptional()
  readonly reaction_users?: string[];
}

results matching ""

    No results matching ""