Skip to content

CallSignature

A TypeScript call signature, e.g. the part after the function keyword in an anonymous function expression, or a call signature in an interface.

Any parameters or type parameters declared in this signature will be placed in the current scope. This component does not make a scope to hold its parameters.

import { CallSignature } from "@alloy-js/typescript";
<CallSignature
parameters={ParameterDescriptor[] | string[]}
parametersChildren={Children}
returnType={Children}
typeParameters={TypeParameterDescriptor[] | string[]}
typeParametersChildren={Children}
/>

Props

parametersoptionalParameterDescriptor[] | string[]

The parameters to the function. Can be an array of strings for parameters which don’t have a type or a default value. Otherwise, it’s an array of ParameterDescriptors.

parametersChildrenoptionalChildren

Raw content to be used as the parameter list.

returnTypeoptionalChildren

The return type of the function.

typeParametersoptionalTypeParameterDescriptor[] | string[]

The type parameters for the function. Can be an array of strings for type parameters which don’t have any constraints or a default type, otherwise it’s an array of TypeParameterDescriptors.

typeParametersChildrenoptionalChildren

Raw content to be used as the type parameter list.