Class Method

Information on a method.

Hierarchy

Property
- Method

Index

Properties

Accessors

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

parameters

get parameters(): Parameter[]

- Defined in method.ts:74
A list of parameters for the method.

Returns Parameter[]

returnType

get returnType(): Type

- Defined in method.ts:50
The return type of the method. (Only available if the --emitDecoratorMetadata compiler option is enabled and the method is decorated.)

Returns Type

type

get type(): Type

Inherited from Property.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[]

Inherited from Property.getAnnotations
- Defined in property.ts:66
Gets a list of annotations for the property.

Returns any[]
Inherited from Property.getAnnotations
- 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

Inherited from Property.getValue
- 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

Inherited from Property.hasAnnotation
- 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

invoke

invoke(obj: any, args?: any[]): any

- Defined in method.ts:32
Invokes the method on the given object with the specified arguments.

Parameters
- obj: any
  
  The object to invoke the method on.
- Optional args: any[]
  
  A list of arguments to pass to the method.
Returns any

setValue

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

Inherited from Property.setValue
- 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