Class Property

Information on a Type property.

Hierarchy

Property
- Method

Index

Properties

Accessors

type

Methods

Properties

Protected context

context: ReflectContext

The ReflectContext that is managing the Type.

name

name: string

The name of the property.

parent

parent: Type

The Type that owns this property.

Accessors

type

get type(): Type

- Defined in property.ts:55
The Type of the property. (Only available if the --emitDecoratorMetadata compiler option is enabled.)

Returns Type

Methods

getAnnotations

getAnnotations(): any[]
getAnnotations<T>(annotationCtr: Constructor<T>): T[]

- Defined in property.ts:66
Gets a list of annotations for the property.

Returns any[]
- Defined in property.ts:72
Gets a list of the specified type of annotations for the property.

Type parameters
- T
Parameters
- annotationCtr: Constructor<T>
  
  The constructor function used to filter the annotations.
Returns T[]

getValue

getValue(obj: Object): any

- Defined in property.ts:91
Gets the value of the property on a target object.

Parameters
- obj: Object
  
  The target object.
Returns any

hasAnnotation

hasAnnotation(annotationCtr: Constructor<any>): boolean

- Defined in property.ts:82
Checks if the property has the specified type of annotation.

Parameters
- annotationCtr: Constructor<any>
  
  The constructor function for the annotation to look for.
Returns boolean

setValue

setValue(obj: Object, value: any): void

- Defined in property.ts:107
Sets the value of the property on a target object.

Parameters
- obj: Object
  
  The target object.
- value: any
  
  The value to set.
Returns void

Generated using TypeDoc