Class ReflectionType<T>

constructor

• new ReflectionType<T = any>(type: Type): ReflectionType<T>

  Constructor for internal use. Use ReflectionType.get to fetch a ReflectionType.

  Type Parameters

  • T = any

  Parameters

  • type: Type

    Type descriptor.

  Returns ReflectionType<T>

ReadonlymutableType

ReadonlysystemType

fullyQualifiedName

• get fullyQualifiedName(): string

  The fully qualified name of the type, including the namespace.

  Returns string

isImmutable

• get isImmutable(): boolean

  Determines if the type is immutable. Meaning the values cannot be modified.

  Returns boolean

isSerializable

• get isSerializable(): boolean

  Determines if the object is serializable.

  Returns boolean

name

• get name(): string

  The full name of given type.

  Returns string

constructDefaultValue

• constructDefaultValue(): any

  Constructs a default value for the type.

  Returns any

  The constructed value or undefined if a default value is not constructible

  Note

  If the type is not default constructible undefined is returned. Types that have the SerializedObjectAttribute will be constructed by invoking their constructor.

createInstance

• createInstance<T = any>(...constructorArguments: any[]): T

  Creates an instance of the specified type using the constructor that best matches the specified parameters.

  Type Parameters

  • T = any

  Parameters

  • ...constructorArguments: any[]

    Arguments to pass to the constructor.

  Returns T

  The newly created object.

findField

• findField(name: string, isStatic?: boolean): ReflectionField

  Searches for the specified member field, using the specified binding constraints.

  Parameters

  • name: string

    The string containing the name of the member field to get.

  • OptionalisStatic: boolean

  Returns ReflectionField

  First member field that was found, if any. Otherwise null.

  Note

  Non-static fields may not have meta data, so if there is no explicit field the field may not be retrieved.

findMembers

• findMembers(name: string): ReflectionMember[]

  Searches for the specified members, using the specified binding constraints.

  Parameters

  • name: string

    The string containing the name of the members to get.

  Returns ReflectionMember[]

  An array containg all ReflectionMember of the type with the specified name.

findMethod

• findMethod(name: string, isStatic: boolean): ReflectionMethod

  Searches for the specified method.

  Parameters

  • name: string

    The string containing the name of the method to get.

  • isStatic: boolean

  Returns ReflectionMethod

  First ReflectionMethod that was found, if any. Otherwise undefined.

findMethodByValue

• findMethodByValue(fnMethod: Function, target?: any): ReflectionMethod

  Searches for the specified method by value. For instance methods, the target instance must be specified.

  Parameters

  • fnMethod: Function

    The method to search for.

  • Optionaltarget: any

    Optionl. The target instance to search for the method in. Without a target only class methods can be found.

  Returns ReflectionMethod

  The ReflectionMethod that matches the given method, if any. Otherwise undefined.

findProperty

• findProperty(name: string, isStatic?: boolean): ReflectionProperty

  Searches for the specified property.

  Parameters

  • name: string

    The string containing the name of the property to get.

  • OptionalisStatic: boolean

  Returns ReflectionProperty

  First ReflectionProperty that was found, if any. Otherwise undefined.

getAllAttributes

• getAllAttributes(includeSuperClasses?: boolean): Attribute[]

  Retrieves all custom attributes defined on this member.

  Parameters

  • OptionalincludeSuperClasses: boolean

  Returns Attribute[]

  All custom attributes defined on this member

getAllFields

• getAllFields(): ReflectionField[]

  Returns all fields.

  Returns ReflectionField[]

  Array of fields in this type conforming to binding flags.

getAllMembers

• getAllMembers(isRecursive: boolean): ReflectionMember[]

  Searches for the specified members, using the specified binding constraints.

  Parameters

  • isRecursive: boolean

    Enable to get members from super classes.

  Returns ReflectionMember[]

  An array of System.Reflection.MemberInfo objects representing the all public members

getAllMethods

• getAllMethods(isRecursive: boolean): ReflectionMethod[]

  Returns all methods.

  Parameters

  • isRecursive: boolean

    Enable to get members from super classes.

  Returns ReflectionMethod[]

  Array of methods.

getAttribute

• getAttribute<T extends Attribute>(
      attributeType: ClassOf<T>,
      includeSuperClasses?: boolean,
  ): T

  Retrieves a Attribute of a specified type that is applied to a specified member.

  Type Parameters

  • T extends Attribute

  Parameters

  • attributeType: ClassOf<T>

    The type of attribute to search for. Only attributes that are assignable to this type are returned.

  • OptionalincludeSuperClasses: boolean

    Determines if the attribute should be searched in super classes. Default: true.

  Returns T

  A custom attribute that matches T, or null if no such attribute is found.

  Note

  Attributes can be added to a class, field or method using decorators.

getAttributes

• getAttributes<T extends Attribute>(
      attributeType: ClassOf<T>,
      includeSuperClasses?: boolean,
  ): T[]

  Retrieves custom attributes of a specified type that is applied to this member.

  Type Parameters

  • T extends Attribute

  Parameters

  • attributeType: ClassOf<T>

    The type of attribute to search for. Only attributes that are assignable to this type are returned.

  • OptionalincludeSuperClasses: boolean

  Returns T[]

  Custom attributes that matche T

getBaseType

• getBaseType(): Type

  Gets the type from which the current type directly inherits.

  Returns Type

  The base type of the current type, or null, if there is no base type.

getDeclaringType

• getDeclaringType(): Type

  Gets the class that declares this member.

  Returns Type

  The Type object for the class that declares this member.

getMethodsWithAttribute

• getMethodsWithAttribute<T extends Attribute>(
      attribute: ClassOf<T>,
      isRecursive: boolean,
  ): { attribute: T; method: ReflectionMethod }[]

  Returns all methods with the specified Attribute.

  Type Parameters

  • T extends Attribute

  Parameters

  • attribute: ClassOf<T>

    Search for methods with the specified Attribute.

  • isRecursive: boolean

    Enable to get members from super classes.

  Returns { attribute: T; method: ReflectionMethod }[]

  Array of methods.

hasAttribute

• hasAttribute<T extends Attribute>(
      attributeType: ClassOf<T>,
      includeSuperClasses?: boolean,
  ): boolean

  Determines if the type is decorated with the specified Attribute.

  Type Parameters

  • T extends Attribute

  Parameters

  • attributeType: ClassOf<T>

    The type of attribute to search for. Only attributes that are assignable to this type are returned.

  • OptionalincludeSuperClasses: boolean

    Determines if the attribute should be searched in super classes. Default: true.

  Returns boolean

  True if the attribute was found on the type.

  Note

  Attributes can be added to a class, field or method using decorators.

isArray

• isArray(): boolean

  Checks if this type is an array type.

  Returns boolean

  Whether this type is an array.

isAssignableFrom

• isAssignableFrom(sourceType: Type): boolean

  Determines whether an instance of the current type can be assigned from an instance of the specified Type.

  Parameters

  • sourceType: Type

    The type to compare with the current type.

  Returns boolean

  true if assignable.

isEnum

• isEnum(): boolean

  Checks if this type is an enumeration type.

  Returns boolean

  Whether this type is an enum.

isPrimitive

• isPrimitive(): boolean

  Gets a value indicating whether the type is one of the primitive types.

  Returns boolean

  true if the type is one of the primitive types; otherwise, false.

isSubclassOf

• isSubclassOf(baseType: Type): boolean

  Checks if this class is subclass of given baseType or the baseType directly.

  Parameters

  • baseType: Type

    Base class to check.

  Returns boolean

  Whether this class is subclass of given base class.

isTypeEqual

• isTypeEqual(otherType: Type): boolean

  Checks if this class is matches the specified otherType.

  Parameters

  • otherType: Type

    The tpye to check.

  Returns boolean

  Whether this class is the same as otherType.

toString

• toString(): string

  Returns a String representing the name of the current Type.

  Returns string

Staticget

• get<T = any>(type: ClassOf<T>): ReflectionType<T>

  Returns the ReflectionType for the specified type.

  Type Parameters

  • T = any

  Parameters

  • type: ClassOf<T>

  Returns ReflectionType<T>

  ReflectionType representing given type or null if type is null.

StaticisSubclassOf

• isSubclassOf(type: Type, baseType: Type): boolean

  Checks if the type is a subclass of given baseType or the baseType directly.

  Parameters

  • type: Type

    Type to check.

  • baseType: Type

    Base type to check.

  Returns boolean

  Whether the type is a subclass of given base type.