Skip to main content
Version: Next

SchemaHelper <Schema>

Index

Methods

getBoolSchema

  • getBoolSchema(): Schema

getFloatSchema

  • getFloatSchema(): Schema

getIntSchema

  • getIntSchema(): Schema

getSchema

  • getSchema(ClzType: any): any

getStringSchema

  • getStringSchema(): Schema

optionalgetSwaggerPropertyKeys

  • getSwaggerPropertyKeys(ClzType: any): string[]
  • Optional adapter hook for OpenAPI property inference. Return all property names that can be inferred from current DTO.

optionalgetSwaggerPropertyMetadata

  • getSwaggerPropertyMetadata(ClzType: any, propertyName: string): Record<string, any>
  • Optional adapter hook for OpenAPI property inference. Return inferred OpenAPI metadata for a single DTO property.

isOptional

  • isOptional(ClzType: any, propertyName: string): boolean

isRequired

  • isRequired(ClzType: any, propertyName: string): boolean

setOptional

  • setOptional(ClzType: any, propertyName?: string): void

setRequired

  • setRequired(ClzType: any, propertyName?: string): void