Class StiFunction

Hierarchy

StiFunction

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new StiFunction(category: string, groupFunctionName: string, functionName: string, description: string, typeOfFunction: string, returnType: Type, returnDescription?: string, argumentTypes?: Type[], argumentNames?: string[], argumentDescriptions?: string[]): StiFunction

Parameters
- category: string
- groupFunctionName: string
- functionName: string
- description: string
- typeOfFunction: string
- returnType: Type
- Default value returnDescription: string = ""
- Default value argumentTypes: Type[] = null
- Default value argumentNames: string[] = null
- Default value argumentDescriptions: string[] = null
Returns StiFunction

Properties

category

category: string = ""

description

description: string = ""

functionName

functionName: string = ""

groupFunctionName

groupFunctionName: string = ""

jsFunction

jsFunction: Function

key

key: string = StiKeyHelper.generateKey()

returnDescription

returnDescription: string = ""

returnType

returnType: Type = null

typeOfFunction

typeOfFunction: string = null

useFullPath

useFullPath: boolean = true

Accessors

argumentDescriptions

get argumentDescriptions(): string[]
set argumentDescriptions(value: string[]): void

Returns string[]
Parameters
- value: string[]
Returns void

argumentNames

get argumentNames(): string[]
set argumentNames(value: string[]): void

Returns string[]
Parameters
- value: string[]
Returns void

argumentTypes

get argumentTypes(): Type[]
set argumentTypes(value: Type[]): void

Returns Type[]
Parameters
- value: Type[]
Returns void

Methods

as

as<T>(type: object | Interface<T>): T

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns T

compareTo

compareTo(func: StiFunction): number

Parameters
- func: StiFunction
Returns number

convertTypeToString

convertTypeToString(typeT: Type, language: StiReportLanguageType): string

Parameters
- typeT: Type
- language: StiReportLanguageType
Returns string

getFunctionString

getFunctionString(language: StiReportLanguageType, addFunctionName?: boolean): string

Parameters
- language: StiReportLanguageType
- Default value addFunctionName: boolean = true
Returns string

getKey

getKey(): string

Implementation of IStiAppFunction.getKey

Returns string

getLongFunctionString

getLongFunctionString(language: StiReportLanguageType): string

Parameters
- language: StiReportLanguageType
Returns string

getName

getName(): string

Implementation of IStiAppFunction.getName

Returns string

implements

implements(): any[]

Returns any[]

invoke

invoke(args: List<any>): any

Implementation of IStiAppFunction.invoke

Parameters
- args: List<any>
Returns any

is

is<T>(type: object | Interface<T>): this

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns this

is2

is2<T>(type: object | Interface<T>): boolean

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns boolean

setKey

setKey(key: string): void

Implementation of IStiAppFunction.setKey

Parameters
- key: string
Returns void

toString

toString(): string

Returns string

Generated using TypeDoc