Interface UIMessage<TName, TProps>

interface UIMessage<TName, TProps> {
    id: string;
    metadata?: {
        merge?: boolean;
        message_id?: string;
        name?: string;
        run_id?: string;
        tags?: string[];
        [key: string]: unknown;
    };
    name: TName;
    props: TProps;
    type: "ui";
}

Type Parameters

  • TName extends string = string
  • TProps extends Record<string, unknown> = Record<string, unknown>

Properties

id metadata? name props type

Properties

id

id: string

Optional metadata

metadata?: {
    merge?: boolean;
    message_id?: string;
    name?: string;
    run_id?: string;
    tags?: string[];
    [key: string]: unknown;
}

Type declaration

  • [key: string]: unknown
  • Optional merge?: boolean
  • Optional message_id?: string
  • Optional name?: string
  • Optional run_id?: string
  • Optional tags?: string[]

name

name: TName

props

props: TProps

type

type: "ui"

Settings

Member Visibility

Theme

On This Page

idmetadatanamepropstype