Skip to content

[I] SignatureFunctionParameter

A function parameter with a simple type constraint.

PropertyModifierTypeDescriptionInherited from
creating?publictrueIf the type is currently being created.FunctionParameterBase.creating
entityKindreadonly"Type"Distinguishes semantic types from values and parameter constraints.FunctionParameterBase.entityKind
instantiationParameters?publicType[]Legacy instantiation metadata. The compiler’s type checker does not populate this field, so its absence does not indicate whether this type is a template instance.FunctionParameterBase.instantiationParameters
isFinishedpublicbooleanReflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface)FunctionParameterBase.isFinished
kindpublic"FunctionParameter"Shared parameter discriminant; mixed selects the constraint representation.FunctionParameterBase.kind
mixedpublicfalseSelects a single type constraint instead of mixed type and value alternatives.-
namepublicstringThe name of this function parameter, as declared in the TypeSpec source.FunctionParameterBase.name
node?publicFunctionParameterNodeNode used to construct this type. If the node is undefined it means the type was dynamically built. With typekit for example.FunctionParameterBase.node
optionalpublicbooleanWhether this parameter is optional.FunctionParameterBase.optional
restpublicbooleanWhether this parameter is a rest parameter (i.e., ...args).FunctionParameterBase.rest
typepublicTypeType required for values supplied to this signature parameter.-