Class ReflectionMethod

Class that represents a reflectable script method.

Hierarchy (View Summary)

ReflectionMember
- ReflectionMethod

Index

Constructors

Properties

declaringType name

Accessors

Methods

acceptsArguments getAllAttributes getAttribute getAttributes hasAttribute invoke isStatic

Constructors

constructor

new ReflectionMethod(
    type: Type,
    name: string,
    isStatic: boolean,
): ReflectionMethod
Parameters
- type: Type
- name: string
- isStatic: boolean
Returns ReflectionMethod

Overrides ReflectionMember.constructor

Properties

`Readonly`declaringType

declaringType: Type

The class that declares this member.

`Readonly`name

name: string

The name of given type.

Accessors

parameterCount

get parameterCount(): number

Gets the number of arguments.

Returns number

Methods

acceptsArguments

acceptsArguments(methodArguments: any[]): boolean
Checks if given method can be called with given arguments.
Parameters
- methodArguments: any[]
  Array of objects that would be passed as arguments to this method, if it was being invoked.
Returns boolean
Whether this method accepts given arguments.

getAllAttributes

getAllAttributes(): Attribute[]

Retrieves all custom attributes defined on this member.

Returns Attribute[]
All custom attributes defined on this member

Inherited from ReflectionMember.getAllAttributes

getAttribute

getAttribute<T extends Attribute>(attributeType: ClassOf<T>): T
Retrieves a custom 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.
Returns T
A custom attribute that matches T, or null if no such attribute is found.

Inherited from ReflectionMember.getAttribute

getAttributes

getAttributes<T extends Attribute>(attributeType: ClassOf<T>): 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.
Returns T[]
Custom attributes that matche T

Inherited from ReflectionMember.getAttributes

hasAttribute

hasAttribute(attributeType: ClassOf<Attribute>): boolean
Checks whether the member has the given attribute type.
Parameters
- attributeType: ClassOf<Attribute>
  The type of attribute to search for.
Returns boolean
True if the attribute exists on the member.

Inherited from ReflectionMember.hasAttribute

invoke

invoke(obj: any, ...parameters: any[]): any
Invokes this method with given parameters and given instance object.
Parameters
- obj: any
  Instance of the object that will be used as 'this' reference.
- ...parameters: any[]
  Array of objects that will be passed as arguments to the method call.
Returns any
Result of the method call.

isStatic

isStatic(): boolean

Checks if this method is static.

Returns boolean
Whether this method is static.

Overrides ReflectionMember.isStatic