Class: BuiltInFunction
compiler.BuiltInFunction
Interface representation of a BuiltInFunction, which is available inside a Kipper program using the specified metadata.
Since
0.1.0
Since
0.11.0 Became a class instead of an interface.
Table of contents
Constructors
Properties
Constructors
constructor
• new BuiltInFunction(identifier
, params
, returnType
)
Parameters
Name | Type |
---|---|
identifier |
string |
params |
BuiltInFunctionArgument [] |
returnType |
ProcessedType |
Defined in
kipper/core/src/compiler/semantics/runtime-built-ins/built-in-function.ts:41
Properties
funcType
• Readonly
funcType: BuiltInTypeFunc
The function type of the built-in function.
Since
0.12.0
Defined in
kipper/core/src/compiler/semantics/runtime-built-ins/built-in-function.ts:39
identifier
• Readonly
identifier: string
The identifier of the global function that should be available inside the program.
The identifier may only contain default numbers and alphabet characters!
Example
Defined in
kipper/core/src/compiler/semantics/runtime-built-ins/built-in-function.ts:19
params
• Readonly
params: BuiltInFunctionArgument
[]
The args that are accepted inside this function. These are represented using BuiltInFunctionArgument.
The index in the array also represents the argument position inside the function. Meaning the first item in the array maps to the first argument inside the function.
Defined in
kipper/core/src/compiler/semantics/runtime-built-ins/built-in-function.ts:27
returnType
• Readonly
returnType: ProcessedType
The expected return of the function. If the return type is KipperVoidType void, then the function will not return anything.
Defined in
kipper/core/src/compiler/semantics/runtime-built-ins/built-in-function.ts:33