InterfaceDeclaration

Create a TypeScript interface declaration.

jsx

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

<InterfaceDeclaration
  default
  doc={Children}
  export
  extends={Children}
  flags={OutputSymbolFlags}
  kind={"type" | "value"}
  metadata={Record<string, unknown>}
  name="string"
  refkey={Refkey | Refkey[]}
 />

stc

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

InterfaceDeclaration({
  default: boolean,
  doc: Children,
  export: boolean,
  extends: Children,
  flags: OutputSymbolFlags,
  kind: "type" | "value",
  metadata: Record<string, unknown>,
  name: string,
  refkey: Refkey | Refkey[],
}).children(children)

Props

children	optionalChildren
default	optionalboolean Whether this is the default export of the module.
doc	optionalChildren Documentation for this declaration
export	optionalboolean Whether to export this declaration from the module.
extends	optionalChildren
flags	optionalOutputSymbolFlags Flags for the symbol created by this component.
kind	optional”type” | “value” Whether this is a declaration of a type (e.g. interface, type alias) or a value (e.g. var, const, let).
metadata	optionalRecord<string, unknown> Arbitrary metadata about this declaration.
name	string The base name of this declaration. May change depending on naming policy and any conflicts.
refkey	optionalRefkey | Refkey[] The refkey or array of refkeys for this declaration.

Remarks

This component will declare a symbol for this interface. The export and default boolean props determine whether and how this symbol is exported from the package.