Class SourceFileProperty

Hierarchy

SourceFileProperty

Implements

SourceFilePropertyImpl

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

Private constructor

new SourceFileProperty(sourceFile: SourceFile, name: string, property: SwaggerDefinitionProperty | SwaggerPathMethodParameter): SourceFileProperty

- Defined in src/lib/source-file-property/index.ts:42
constructor

Parameters
- sourceFile: SourceFile
  
  所属文件
- name: string
  
  名称
- property: SwaggerDefinitionProperty | SwaggerPathMethodParameter
  
  SwaggerDefinitionProperty
Returns SourceFileProperty

Properties

Readonly name

name: string

Readonly property

property: SwaggerDefinitionProperty | SwaggerPathMethodParameter

Readonly sourceFile

sourceFile: SourceFile

Accessors

description

get description(): undefined | string

- Defined in src/lib/source-file-property/index.ts:65
获取描述

Returns undefined | string

format

get format(): undefined | string

- Defined in src/lib/source-file-property/index.ts:77
获取格式

Returns undefined | string

in

get in(): undefined | string

- Defined in src/lib/source-file-property/index.ts:89
获取in

Returns undefined | string

ref

get ref(): undefined | string

- Defined in src/lib/source-file-property/index.ts:109
外部依赖

Returns undefined | string

required

get required(): undefined | boolean

- Defined in src/lib/source-file-property/index.ts:99
是否required

Returns undefined | boolean

type

get type(): undefined | string

- Defined in src/lib/source-file-property/index.ts:53
数据类型

Returns undefined | string

Methods

isGeneric

isGeneric(): boolean

- Defined in src/lib/source-file-property/index.ts:126
检测当前成员是否为泛型参数

Returns boolean

Static create

create(option: SourceFilePropertyImpl): SourceFileProperty

- Defined in src/lib/source-file-property/index.ts:140
创建成员

Parameters
- option: SourceFilePropertyImpl
Returns SourceFileProperty