Interface ServerMessageDescription

interface ServerMessageDescription {
    additionalDefs?: MessageDefinition<IdMessageBase>[];
    definitionPath: string;
    defRequest?: MessageDefinition<IdMessageBase>;
    defResponse?: MessageDefinition<IdMessageBase>;
    mermaidSequenceDiagram: string;
    shortDescription: string;
    text: ((shell: RShell) => Promise<string>);
    title: string;
    type: "request" | "response";
}

Properties

additionalDefs? definitionPath defRequest? defResponse? mermaidSequenceDiagram shortDescription text title type

Properties

Optional ReadonlyadditionalDefs

additionalDefs?: MessageDefinition<IdMessageBase>[]

ReadonlydefinitionPath

definitionPath: string

Optional ReadonlydefRequest

defRequest?: MessageDefinition<IdMessageBase>

Optional ReadonlydefResponse

defResponse?: MessageDefinition<IdMessageBase>

ReadonlymermaidSequenceDiagram

mermaidSequenceDiagram: string

ReadonlyshortDescription

shortDescription: string

Readonlytext

text: ((shell: RShell) => Promise<string>)

Readonlytitle

title: string

Readonlytype

type: "request" | "response"

Settings

Member Visibility

On This Page

Properties