Class FunctionKind<Specifics>

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

Type Parameters

Specifics extends TypirSpecifics

Implements

Index

Constructors

Properties

$name functions options services

Methods

calculateIdentifier collectOptions create createFunctionManager createUniqueFunctionValidation enforceFunctionName enforceParameterName get getOutputTypeForFunctionCalls getParameterRepresentation hasFunctionName hasParameterName

Constructors

constructor

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

Properties

`Readonly`$name

$name: string

`Readonly`functions

functions: AvailableFunctionsManager<Specifics>

`Readonly`options

options: Readonly<FunctionKindOptions<Specifics>>

`Readonly`services

services: TypirServices<Specifics>

Methods

calculateIdentifier

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

`Protected`collectOptions

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

create

create(
typeDetails: FunctionTypeDetails<Specifics>,
): FunctionConfigurationChain<Specifics>
Parameters
- typeDetails: FunctionTypeDetails<Specifics>
Returns FunctionConfigurationChain<Specifics>
Implementation of FunctionFactoryService.create
- Defined in kinds/function/function-kind.ts:188

`Protected`createFunctionManager

createFunctionManager(): AvailableFunctionsManager<Specifics>
Returns AvailableFunctionsManager<Specifics>
- Defined in kinds/function/function-kind.ts:180

createUniqueFunctionValidation

createUniqueFunctionValidation(
options: RegistrationOptions,
): ValidationRule<Specifics>
Creates a validation rule which checks, that the function types are unique.
Parameters
- options: RegistrationOptions
Returns ValidationRule<Specifics>
Implementation of FunctionFactoryService.createUniqueFunctionValidation
- Defined in kinds/function/function-kind.ts:240

enforceFunctionName

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

enforceParameterName

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

get

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

getOutputTypeForFunctionCalls

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

getParameterRepresentation

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

hasFunctionName

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

hasParameterName

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