InterfaceMethod

An interface method declaration.

Props for [unresolved link] component

jsx

import { InterfaceMethod } from "@alloy-js/typescript";

<InterfaceMethod
  async
  doc={Children}
  name={string | Namekey}
  parameters={ParameterDescriptor[] | string[]}
  parametersChildren={Children}
  refkey={Refkey | Refkey[]}
  returnType={Children}
  typeParameters={TypeParameterDescriptor[] | string[]}
  typeParametersChildren={Children}
>
  {children}
</InterfaceMethod>

stc

import { InterfaceMethod } from "@alloy-js/typescript/stc";

InterfaceMethod({
  async: boolean,
  doc: Children,
  name: string | Namekey,
  parameters: ParameterDescriptor[] | string[],
  parametersChildren: Children,
  refkey: Refkey | Refkey[],
  returnType: Children,
  typeParameters: TypeParameterDescriptor[] | string[],
  typeParametersChildren: Children,
}).children(children)

Props

async	optionalboolean If the method is async. It will change the returnType from T to Promise<T>
children	optionalChildren Jsx content
doc	optionalChildren Documentation for this method.
name	string | Namekey Interface member name
parameters	optionalParameterDescriptor[] | 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.
parametersChildren	optionalChildren Raw content to be used as the parameter list.
refkey	optionalRefkey | Refkey[] Ref key for the member declaration
returnType	optionalChildren The return type of the function.
typeParameters	optionalTypeParameterDescriptor[] | 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.
typeParametersChildren	optionalChildren Raw content to be used as the type parameter list.

Remarks

Providing parameters and type parameters can be accomplished in one of three ways:

1. As an array of TypeParameterDescriptors or TypeParameterDescriptors.
2. As raw content via the parametersChildren or typeParametersChildren props.
3. As a child of this component via the [unresolved link] or [unresolved link] components.

Example

(foo: string, bar: number) => void