Class FunctionKind

Represents signatures of executable code.

Constraints of overloaded functions:

no duplicated variants!
The names of all paramaters don't matter for functions to be unique.
a variant is uniquely identified by: function name (if available), types of input parameters; options.identifierPrefix
For overloaded functions, it is not enough to have different output types or different parameter names!

TODO possible Extensions:

multiple output parameters
create variants of this, e.g. functions, procedures, lambdas
(structural vs nominal typing? somehow realized by the three options above ...)
optional parameters
parameters which are used for output AND input

Implements

Index

Constructors

Properties

$name mapNameTypes options services

Methods

addedEdge addedType calculateIdentifier collectOptions create enforceFunctionName enforceParameterName get getOutputTypeForFunctionCalls getParameterRepresentation hasFunctionName hasParameterName removedEdge removedType

Constructors

constructor

new FunctionKind(
services: TypirServices,
options?: Partial<FunctionKindOptions>,
): FunctionKind
Parameters
- services: TypirServices
- Optionaloptions: Partial<FunctionKindOptions>
Returns FunctionKind
- Defined in kinds/function/function-kind.ts:136

Properties

`Readonly`$name

$name: "FunctionKind"

`Readonly`mapNameTypes

mapNameTypes: Map<string, OverloadedFunctionDetails> = ...

Limitations

Works only, if function types are defined using the createFunctionType(...) function below!

`Readonly`options

options: Readonly<FunctionKindOptions>

`Readonly`services

services: TypirServices

Methods

addedEdge

addedEdge(_edge: TypeEdge): void
Parameters
- _edge: TypeEdge
Returns void
Implementation of TypeGraphListener.addedEdge
- Defined in kinds/function/function-kind.ts:288

addedType

addedType(_newType: Type, _key: string): void
Parameters
- _newType: Type
- _key: string
Returns void
Implementation of TypeGraphListener.addedType
- Defined in kinds/function/function-kind.ts:272

calculateIdentifier

calculateIdentifier(typeDetails: FunctionTypeDetails): string
Parameters
- typeDetails: FunctionTypeDetails
Returns string
Implementation of FunctionFactoryService.calculateIdentifier
- Defined in kinds/function/function-kind.ts:296

`Protected`collectOptions

collectOptions(options?: Partial<FunctionKindOptions>): FunctionKindOptions
Parameters
- Optionaloptions: Partial<FunctionKindOptions>
Returns FunctionKindOptions
- Defined in kinds/function/function-kind.ts:238

create

create<T>(
typeDetails: CreateFunctionTypeDetails<T>,
): TypeInitializer<FunctionType>
Type Parameters
- T
Parameters
- typeDetails: CreateFunctionTypeDetails<T>
Returns TypeInitializer<FunctionType>
Implementation of FunctionFactoryService.create
- Defined in kinds/function/function-kind.ts:256

enforceFunctionName

enforceFunctionName(name: undefined | string, enforce: boolean): void
Parameters
- name: undefined | string
- enforce: boolean
Returns void
- Defined in kinds/function/function-kind.ts:317

enforceParameterName

enforceParameterName(name: undefined | string, enforce: boolean): void
Parameters
- name: undefined | string
- enforce: boolean
Returns void
- Defined in kinds/function/function-kind.ts:326

get

get(typeDetails: FunctionTypeDetails): TypeReference<FunctionType>
Parameters
- typeDetails: FunctionTypeDetails
Returns TypeReference<FunctionType>
Implementation of FunctionFactoryService.get
- Defined in kinds/function/function-kind.ts:252

getOutputTypeForFunctionCalls

getOutputTypeForFunctionCalls(functionType: FunctionType): undefined | Type
Parameters
- functionType: FunctionType
Returns undefined | Type
- Defined in kinds/function/function-kind.ts:260

getParameterRepresentation

getParameterRepresentation(parameter: NameTypePair): string
Parameters
- parameter: NameTypePair
Returns string
- Defined in kinds/function/function-kind.ts:308

hasFunctionName

hasFunctionName(name: undefined | string): name is string
Parameters
- name: undefined | string
Returns name is string
- Defined in kinds/function/function-kind.ts:322

hasParameterName

hasParameterName(name: undefined | string): name is string
Parameters
- name: undefined | string
Returns name is string
- Defined in kinds/function/function-kind.ts:331

removedEdge

removedEdge(_edge: TypeEdge): void
Parameters
- _edge: TypeEdge
Returns void
Implementation of TypeGraphListener.removedEdge
- Defined in kinds/function/function-kind.ts:291

removedType

removedType(type: Type, _key: string): void
Parameters
- type: Type
- _key: string
Returns void
Implementation of TypeGraphListener.removedType
- Defined in kinds/function/function-kind.ts:275