Class Reflection

The Reflection class provides reflection utilities for TypeScript types.

Index

Constructors

Accessors

Methods

canConvertTypes convertType createInstance get getClassesFromModule getInternalTypes getPropertyNames getReflectionType getReflectionTypeForInstance getSubclassesForBaseType getType getTypeFromName invoke iterateSubclassesForBaseType set

Constructors

constructor

new Reflection(): Reflection
Returns Reflection

Accessors

`Static`allTypes

get allTypes(): Type[]
Returns all types defined in all assemblies in current domain.

Returns Type[]

Methods

`Static`canConvertTypes

canConvertTypes(sourceType, targetType): boolean
Checks if conversion between two types can be performed by Reflection.ConvertType.
Parameters
- sourceType: Type
  Source type that will be converted.
- targetType: Type
  Type to convert the object into.
Returns boolean
Whether the conversion can be performed.

`Static`convertType

convertType(source, targetType): any
Tries to convert an object to given target type.
Parameters
- source: any
  Source object that will be converted.
- targetType: Type
  Type to convert the object into.
Returns any
Resulting converted object.

`Static`createInstance

createInstance<T>(type, ...parameters): any
Construct a new instance of type by calling it at new type(...parameters).
Type Parameters
- T
Parameters
- type: ClassOf<T>
  The type of object to be constructed.
- Rest...parameters: any[]
  The constructor parameters.
Returns any
The newly created instance of type.

`Static`get

get(instance, propertyName): any
Gets the value from a property or field.
Parameters
- instance: any
  The instance to access the property or field from.
- propertyName: string
  The name of the property to be retrieved.
Returns any
The value of the property.

`Static`getClassesFromModule

getClassesFromModule(module): Generator<ReflectionType, any, any>
Gets a generation that iterates over all classes of the specified module.
Parameters
- module: object
Returns Generator<ReflectionType, any, any>

`Static`getInternalTypes

getInternalTypes(reflectionTypes): Type[]
Returns array with types that are represented by input ReflectionType array for use in interop.
Parameters
- reflectionTypes: Type[]
Returns Type[]
Array of System.Type with types represented in input array.

`Static`getPropertyNames

getPropertyNames(instance, includeFunctions): string[]
Gets an array of all properties, fields and method of the object.
Parameters
- instance: any
  The instance to fetch property names from.
- includeFunctions: boolean
Returns string[]
An array of all instance property names.

`Static`getReflectionType

getReflectionType(type): ReflectionType
Returns the ReflectionType for the specified type.
Parameters
- type: Type
Returns ReflectionType
ReflectionType representing given type or null if type is null.

`Static`getReflectionTypeForInstance

getReflectionTypeForInstance(instance): ReflectionType
Returns type of given instance.
Parameters
- instance: any
  The instance to inspect.
Returns ReflectionType
ReflectionType representing type of given object.

`Static`getSubclassesForBaseType

getSubclassesForBaseType(type): ReflectionType[]
Returns an array of all classes that implement the specified base type.
Parameters
- type: Type
  The base type.
Returns ReflectionType[]

`Static`getType

getType<T>(instance): SubclassOf<T>
Returns type of given instance.
Type Parameters
- T
Parameters
- instance: T
  The instance to inspect.
Returns SubclassOf<T>
The type of the given instance.

Throws
if instance is null

`Static`getTypeFromName

getTypeFromName(name): Type
Returns type that has given name.
Parameters
- name: string
  Name of type to search for.
Returns Type
ReflectionType representing type with given name.

`Static`invoke

invoke(instance, methodName, ...parameters): any
Invokes a method on instance.
Parameters
- instance: any
  The instance to invoke the method on.
- methodName: string
  The name of the method to be invoked.
- Rest...parameters: any[]
  An array of parameters to be passed to the method invocation.
Returns any
The return value of the method call.

`Static`iterateSubclassesForBaseType

iterateSubclassesForBaseType(type): Generator<ReflectionType, any, any>
Returns an array of all classes that implement the specified base type.
Parameters
- type: Type
  The base type.
Returns Generator<ReflectionType, any, any>

`Static`set

set(instance, propertyName, propertyValue): void
Sets the value of a property or field.
Parameters
- instance: any
  The instance to access the property or field from.
- propertyName: string
  The name of the property to be set.
- propertyValue: any
  The value of the property.
Returns void