Skip to content

ParameterDescriptorBase

Common properties for ParameterDescriptor and FunctionTypeParameterDescriptor.

docoptional ChildrenDocumentation for the parameter.
metadataoptional Record<string, unknown>Arbitrary metadata for the parameter symbol.
namestring | NamekeyThe name of the parameter.
nullishoptional booleanWhether the parameter is can be null or undefined. when optional is true, this will be set to true by default, but explicitly setting this to false will override that.
optionaloptional booleanWhether the parameter is optional.
refkeyoptional Refkey | Refkey[]The refkey for this parameter.
restoptional booleanWeather the parameter is rest parameter.
typeoptional ChildrenThe type of the parameter.