ClassMirror | ClassMirror API

Type parameters

T: ClassDecorate = any

Hierarchy

DeclarationMirror<T>
- ClassMirror

Constructors

constructor

new ClassMirror<T>(): ClassMirror<T>

Inherited from DeclarationMirror.constructor
Type parameters
- T: ClassDecorate<any, T> = any
Returns ClassMirror<T>

Properties

Readonly decorates

decorates: Set<T> = ...

metadata collection 元数据集合

Private Readonly instanceMembers

instanceMembers: Map<string | symbol, MethodMirror<any, any> | PropertyMirror<any>> = ...

Instance members 实例成员集合

Private Readonly parameters

parameters: Map<number, ParameterMirror<any>> = ...

构造函数参数此处的parameters.size数量是构造函数使用了ParameterMirror.createDecorator创建的装饰的成员数量, 要获取所有参数的数量，请使用方法 [new ClassMirror].getDesignParamTypes.

parent

parent: null | ClassMirror<any> = null

父ClassMirror

Private Readonly staticMembers

staticMembers: Map<string | symbol, MethodMirror<any, any> | PropertyMirror<any>> = ...

Static members 静态成员稽核

target

target: Object

target Mirror映射的目标

Methods

getAllDecorates

getAllDecorates<M>(type?: ClassConstructor<M>): M[]

- Defined in mirrors/class-mirror/index.ts:125
获取所有元数据包含父类

Type parameters
- M: ClassDecorate<any, M> = T
Parameters
- Optional type: ClassConstructor<M>
Returns M[]

getAllInstanceMembers

getAllInstanceMembers(): Map<PropertyKey, MethodMirror<any, any> | PropertyMirror<any>>

- Defined in mirrors/class-mirror/index.ts:293
获取所有的实例成员含父类（基类）中的实例成员

Returns Map<PropertyKey, MethodMirror<any, any> | PropertyMirror<any>>

getAllMethods

getAllMethods(): Map<PropertyKey, MethodMirror<any, any>>

- Defined in mirrors/class-mirror/index.ts:221
获取所有实例方法成员含父类（基类）中的实例成员方法

Returns Map<PropertyKey, MethodMirror<any, any>>

getAllMirrors

getAllMirrors<T>(type: undefined | ClassConstructor<T>, isStatic?: boolean): T[]

- Defined in mirrors/class-mirror/index.ts:334
获取所有的Mirror 含父类（基类）。

Type parameters
- T: MethodMirror<any, any> | PropertyMirror<any> = MethodMirror<any, any> | PropertyMirror<any>
Parameters
- type: undefined | ClassConstructor<T>
  
  参数可以是 MethodMirror 或者 PropertyMirror 为 undefined 时返回所有映射实例。
- isStatic: boolean = false
  
  是否获取静态成员。获取指定的 mirror 集合，需要指定 type。
Returns T[]

getAllProperties

getAllProperties(): Map<PropertyKey, PropertyMirror<any>>

- Defined in mirrors/class-mirror/index.ts:257
获取所有实例成员含父类（基类）中的实例成员

Returns Map<PropertyKey, PropertyMirror<any>>

getDecorates

getDecorates<M>(type?: ClassConstructor<M>): M[]

Overrides DeclarationMirror.getDecorates
- Defined in mirrors/class-mirror/index.ts:137
获取元数据集合

Type parameters
- M: ClassDecorate<any, M> = T
Parameters
- Optional type: ClassConstructor<M>
  
  类型, 参数继承至 ClassMetadata。
Returns M[]

getDesignParamTypes

getDesignParamTypes<T>(): T[]

- Defined in mirrors/class-mirror/index.ts:180
获取构造函数参数类型, 不包含父类（基类）.

Type parameters
- T: Function = Function
Returns T[]

getInstanceMembers

getInstanceMembers(): Map<PropertyKey, MethodMirror<any, any> | PropertyMirror<any>>

- Defined in mirrors/class-mirror/index.ts:310
获取实例成员不含父类（基类）中的实例成员

Returns Map<PropertyKey, MethodMirror<any, any> | PropertyMirror<any>>

getMethod

getMethod(propertyKey: PropertyKey): undefined | MethodMirror<any, any>

- Defined in mirrors/class-mirror/index.ts:250
获取含父类（基类）中指定 propertyKey 的实例成员方法

Parameters
- propertyKey: PropertyKey
Returns undefined | MethodMirror<any, any>

getMethods

getMethods(): Map<PropertyKey, MethodMirror<any, any>>

- Defined in mirrors/class-mirror/index.ts:235
获取所有实例方法成员不含父类（基类）中的实例成员方法

Returns Map<PropertyKey, MethodMirror<any, any>>

getMirror

getMirror<T>(mirrorKey: string | symbol, isStatic?: boolean): undefined | T

- Defined in mirrors/class-mirror/index.ts:369
获取 PropertyMirror, 不包含父类（基类）.

Type parameters
- T: MethodMirror<any, any> | PropertyMirror<any> = MethodMirror<any, any> | PropertyMirror<any>
Parameters
- mirrorKey: string | symbol
- isStatic: boolean = false
  
  根据元数据 PropertyMetadata 获取 PropertyMirror。
Returns undefined | T

getMirrors

getMirrors<T>(type: undefined | ClassConstructor<T>, isStatic?: boolean): T[]

- Defined in mirrors/class-mirror/index.ts:351
获取所有的Mirror 不含父类（基类）。

Type parameters
- T: MethodMirror<any, any> | PropertyMirror<any> = MethodMirror<any, any> | PropertyMirror<any>
Parameters
- type: undefined | ClassConstructor<T>
  
  参数可以是 MethodMirror 或者 PropertyMirror 为 undefined 时返回所有映射实例。
- isStatic: boolean = false
  
  是否获取静态成员。获取指定的 mirror 集合，需要指定 type。
Returns T[]

getParameter

getParameter<T>(index: number): ParameterMirror<T>

- Defined in mirrors/class-mirror/index.ts:156
获取指定位置的参数装饰器反射, 不包含父类（基类）.

Type parameters
- T: ParameterDecorate<any, T>
Parameters
- index: number
  
  装饰器位置
Returns ParameterMirror<T>

getParameters

getParameters(): Map<number, ParameterMirror<any>>

- Defined in mirrors/class-mirror/index.ts:148
获取参数列表

Returns Map<number, ParameterMirror<any>>

getProperties

getProperties(): Map<PropertyKey, PropertyMirror<any>>

- Defined in mirrors/class-mirror/index.ts:271
获取所有实例属性成员不含父类（基类）中的实例成员

Returns Map<PropertyKey, PropertyMirror<any>>

getProperty

getProperty(propertyKey: PropertyKey): undefined | PropertyMirror<any>

- Defined in mirrors/class-mirror/index.ts:286
获取含父类（基类）中指定 propertyKey 的实例成员

Parameters
- propertyKey: PropertyKey
Returns undefined | PropertyMirror<any>

getStaticMethod

getStaticMethod(propertyKey: PropertyKey): undefined | MethodMirror<any, any>

- Defined in mirrors/class-mirror/index.ts:188
Parameters
- propertyKey: PropertyKey
Returns undefined | MethodMirror<any, any>

getStaticMethods

getStaticMethods(): Map<PropertyKey, MethodMirror<any, any>>

- Defined in mirrors/class-mirror/index.ts:195
获取所有静态方法成员

Returns Map<PropertyKey, MethodMirror<any, any>>

getStaticProperties

getStaticProperties(): Map<PropertyKey, PropertyMirror<any>>

- Defined in mirrors/class-mirror/index.ts:208
获取所有静态属性成员

Returns Map<PropertyKey, PropertyMirror<any>>

removeMirror

removeMirror(mirrorKey: string | symbol, isStatic?: boolean): void

- Defined in mirrors/class-mirror/index.ts:320
移除一个Mirror，不含父类（基类）中的实例成员 Remove mirror

Parameters
- mirrorKey: string | symbol
- isStatic: boolean = false
Returns void

setMirror

setMirror<T>(mirrorKey: string | symbol, mirror: T, isStatic?: boolean): void

- Defined in mirrors/class-mirror/index.ts:388
添加 mirror，只在当前类中添加

Type parameters
- T: MethodMirror<any, any> | PropertyMirror<any>
Parameters
- mirrorKey: string | symbol
- mirror: T
  
  DeclarationMirror
- isStatic: boolean = false
  
  是否为静态成员使用该方法可以添加一个Mirror 可以是 MethodMirror 也可以是 PropertyMirror， ParameterMirror不应添加至此处，ParameterMirror属于。 MethodMirror管理.
Returns void

setParameter

setParameter<T>(index: number, mirror: ParameterMirror<T>): Map<number, ParameterMirror<T>>

- Defined in mirrors/class-mirror/index.ts:167
设置指定位置的参数装饰器反射, 不包含父类（基类）.

Type parameters
- T: ParameterDecorate<any, T>
Parameters
- index: number
- mirror: ParameterMirror<T>
Returns Map<number, ParameterMirror<T>>

Static createDecorator

createDecorator(classDecorate: ClassDecorateFactory | ClassDecorate<any>): ClassDecorator

- Defined in mirrors/class-mirror/index.ts:42
创建类装饰器

Parameters
- classDecorate: ClassDecorateFactory | ClassDecorate<any>
  
  使用此方法可以创建一个类装饰器
Returns ClassDecorator

Static isStaticMember

isStaticMember<T>(target: T): boolean

- Defined in mirrors/class-mirror/index.ts:88
判断是否为静态成员

Type parameters
- T: Object
Parameters
- target: T
Returns boolean

Static reflect

reflect<T>(type: T): ClassMirror<any>

- Defined in mirrors/class-mirror/index.ts:67
获取映射数据

Type parameters
- T: Function
Parameters
- type: T
  
  使用此方法可以获取指定type上的 ClassMirror实例.
Returns ClassMirror<any>

Type parameters

T: ClassDecorate = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

T: ClassDecorate<any, T> = any

Returns ClassMirror<T>

Properties

Readonly decorates

Private Readonly instanceMembers

Private Readonly parameters

parent

Private Readonly staticMembers

target

Methods

getAllDecorates

Type parameters

M: ClassDecorate<any, M> = T

Parameters

Optional type: ClassConstructor<M>

Returns M[]

getAllInstanceMembers

Returns Map<PropertyKey, MethodMirror<any, any> | PropertyMirror<any>>

getAllMethods

Returns Map<PropertyKey, MethodMirror<any, any>>

getAllMirrors

Type parameters

T: MethodMirror<any, any> | PropertyMirror<any> = MethodMirror<any, any> | PropertyMirror<any>

Parameters

type: undefined | ClassConstructor<T>

isStatic: boolean = false

Returns T[]

getAllProperties

Returns Map<PropertyKey, PropertyMirror<any>>

getDecorates

Type parameters

M: ClassDecorate<any, M> = T

Parameters

Optional type: ClassConstructor<M>

Returns M[]

getDesignParamTypes

Type parameters

T: Function = Function

Returns T[]

getInstanceMembers

Returns Map<PropertyKey, MethodMirror<any, any> | PropertyMirror<any>>

getMethod

Parameters

propertyKey: PropertyKey

Returns undefined | MethodMirror<any, any>

getMethods

Returns Map<PropertyKey, MethodMirror<any, any>>

getMirror

Type parameters

T: MethodMirror<any, any> | PropertyMirror<any> = MethodMirror<any, any> | PropertyMirror<any>

Parameters

mirrorKey: string | symbol

isStatic: boolean = false

Returns undefined | T

getMirrors

Type parameters

T: MethodMirror<any, any> | PropertyMirror<any> = MethodMirror<any, any> | PropertyMirror<any>

Parameters

type: undefined | ClassConstructor<T>

isStatic: boolean = false

Returns T[]

getParameter

Type parameters

T: ParameterDecorate<any, T>

Parameters

index: number

Returns ParameterMirror<T>

getParameters

Returns Map<number, ParameterMirror<any>>

getProperties