FunctionDeclaration

jsx

import { FunctionDeclaration } from "@alloy-js/go";

<FunctionDeclaration
  doc={Children}
  name={string | Namekey}
  parameters={FunctionParameterProps[]}
  receiver={Children}
  refkey={Refkey}
  returns={Children}
  singleLine
  typeParameters={TypeParameterProps[]}
>
  {children}
</FunctionDeclaration>

stc

import { FunctionDeclaration } from "@alloy-js/go/stc";

FunctionDeclaration({
  doc: Children,
  name: string | Namekey,
  parameters: FunctionParameterProps[],
  receiver: Children,
  refkey: Refkey,
  returns: Children,
  singleLine: boolean,
  typeParameters: TypeParameterProps[],
}).children(children)

Props

children	optionalChildren
doc	optionalChildren Doc comment
name	string | Namekey
parameters	optionalFunctionParameterProps[]
receiver	optionalChildren Go receiver (for methods)
refkey	optionalRefkey
returns	optionalChildren
singleLine	optionalboolean Whether to render the function in a single line. This will only compile if children is a single line as well. This is not common in Go, so use with caution.
typeParameters	optionalTypeParameterProps[] Type parameters for generic functions